diff --git a/.gitignore b/.gitignore index cc4d37c..2ebf4c1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ webex webex-cli *.exe dist/ +webex-mcp.dxt +webex.skill # Codegen intermediates codegen/api_outline.json @@ -24,3 +26,4 @@ Thumbs.db *.swp *.swo /docs/wxcc-search +.webex-cli/ diff --git a/CLAUDE_DESKTOP.md b/CLAUDE_DESKTOP.md new file mode 100644 index 0000000..ef52d9b --- /dev/null +++ b/CLAUDE_DESKTOP.md @@ -0,0 +1,146 @@ +# Webex MCP — Claude Desktop Setup + +This guide covers installing and using the Webex MCP server with **Claude Desktop** specifically. For Claude Code (CLI), see the [main README](README.md). + +## Requirements + +- **Claude Desktop** — latest version +- **Webex CLI** — installed and authenticated on each user's machine + ```bash + # Install + curl -fsSL https://raw.githubusercontent.com/Cloverhound/webex-cli/main/install.sh | sh + + # Authenticate (opens browser for OAuth) + webex login + ``` +- **Platform** — macOS, Windows, or Linux + +The MCP server runs **locally** using stdio transport — no network port is opened and no shared server is required. Each user's own Webex credentials are used automatically. + +--- + +## Installation + +### Option 1 — Admin Portal (Team Distribution) + +Admins can distribute the extension to the entire team without each user needing to install it manually. + +1. Build the extension package: + ```bash + git clone https://github.com/Cloverhound/webex-cli.git + cd webex-cli + make extension # produces webex-mcp.dxt + ``` +2. Upload `webex-mcp.dxt` to the [Claude admin portal](https://console.anthropic.com) under **Extensions** +3. Enable it for your team or org +4. Each team member must still install the Webex CLI and run `webex login` on their own machine + +### Option 2 — Individual Install (Double-click) + +Download or build `webex-mcp.dxt` and double-click it in Finder (macOS) or Explorer (Windows). Claude Desktop installs the extension automatically. + +### Option 3 — HTTP Transport (Manual Config) + +If you prefer HTTP transport instead of the DXT extension: + +1. Start the MCP server: + ```bash + webex mcp serve --http # binds to 127.0.0.1:47890 + webex mcp serve --http --http-addr 127.0.0.1:9000 # custom port + ``` +2. Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS): + ```json + { + "mcpServers": { + "webex": { "url": "http://localhost:47890/mcp" } + } + } + ``` +3. Restart Claude Desktop +4. Stop the server when done: `webex mcp stop` + +The HTTP server only binds to loopback (`127.x.x.x`) and cannot be exposed on public interfaces. + +--- + +## Tools + +The extension exposes four tools: + +| Tool | Maps to | Auto-approvable | Description | +|---|---|---|---| +| `webex_read` | GET | Yes | List, get, download, export, search — read-only operations | +| `webex_write` | POST / PUT / PATCH / DELETE | No | Create, update, delete — always prompts for confirmation | +| `webex_help` | — | Yes | Get help text and flag listings for any command | +| `webex_usage` | — | Yes | View recent MCP command history with timing and status | + +`webex_read`, `webex_help`, and `webex_usage` are safe to auto-approve. `webex_write` is intentionally kept separate so write operations always require explicit user confirmation. + +--- + +## Adding the Skill for Better Results + +The DXT extension provides Claude Desktop with the **tools** to execute Webex commands, but not the **knowledge** of how to use them optimally. Without the skill, Claude will use `webex_help` to discover commands on demand — functional, but slower and more prone to mistakes on edge cases like CC `--orgid` handling, pagination, and subcommand naming exceptions. + +**The fix:** Use a Claude Desktop **Project** and paste the skill content into the Project instructions. This is the Claude Desktop equivalent of the Claude Code skill system. + +### Setup + +1. In Claude Desktop, create a new **Project** (e.g., "Webex Admin") +2. Open **Project Instructions** +3. Paste the contents of [`skill/SKILL.md`](skill/SKILL.md) — this covers auth, command structure, global flags, and best practices +4. Optionally add the relevant sub-skill files for the areas your team uses most: + +| Area | File | When to include | +|---|---|---| +| Admin | [`skill/admin/SKILL.md`](skill/admin/SKILL.md) | Managing people, licenses, orgs | +| Calling | [`skill/calling/SKILL.md`](skill/calling/SKILL.md) | Locations, queues, devices, recordings | +| Contact Center | [`skill/cc/SKILL.md`](skill/cc/SKILL.md) | Sites, flows, agents, entry points | +| Devices | [`skill/device/SKILL.md`](skill/device/SKILL.md) | Device configs, workspaces, xAPI | +| Meetings | [`skill/meetings/SKILL.md`](skill/meetings/SKILL.md) | Recordings, transcripts, scheduling | +| Messaging | [`skill/messaging/SKILL.md`](skill/messaging/SKILL.md) | Rooms, messages, teams | + +With the skill in Project instructions, Claude will know upfront about `--paginate`, RSQL filters, the CC `--orgid` auto-population, download patterns, and other behaviours that would otherwise require multiple `webex_help` round-trips to discover. + +--- + +## Authentication + +The extension uses the same credentials as the Webex CLI — run `webex login` once and the MCP server picks them up automatically. Token refresh is handled transparently. + +```bash +webex auth status # confirm you are logged in +webex auth list # list all stored users +webex auth switch # change default user +webex auth set-org # set a persistent org override (partner admins) +``` + +Multiple Webex accounts are supported. Switch the default user with `webex auth switch` and restart Claude Desktop (or `webex mcp stop` + re-open for HTTP transport). + +--- + +## Troubleshooting + +**"webex: command not found"** +The install script adds `~/.local/bin` to PATH. If Claude Desktop launches before your shell profile is sourced, the binary may not be found. Fix by setting an absolute path in the extension config or ensuring `~/.local/bin` is in your system PATH (not just shell PATH). + +For the HTTP transport option, edit `claude_desktop_config.json` to use an absolute path: +```json +{ + "mcpServers": { + "webex": { + "command": "/Users/yourname/.local/bin/webex", + "args": ["mcp", "serve"] + } + } +} +``` + +**"No running MCP server found" (HTTP mode)** +Run `webex mcp serve --http` before opening Claude Desktop, or switch to the DXT extension which starts the server automatically via stdio. + +**Not authenticated** +Run `webex login` in a terminal, then retry. Tokens are stored in the OS keyring and shared with the MCP server automatically. + +**Wrong Webex org** +Use `webex auth set-org ` to set a persistent org override, or pass `--organization ` on individual commands via the `flags` parameter. diff --git a/Makefile b/Makefile index 5a32ccb..d03d0b8 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: build download codegen refresh check clean +.PHONY: build download codegen refresh check clean extension skill build: go build -o webex . @@ -9,12 +9,27 @@ download: codegen: cd codegen && python3 extract_api_spec.py cd codegen && python3 generate_cli.py + cd codegen && python3 generate_skills.py refresh: download codegen build check: build go vet ./... +extension: build + cd extension && zip -r ../webex-mcp.dxt manifest.json icon.png + @echo "Built webex-mcp.dxt" + +skill: + @python3 -c "\ +import zipfile; \ +z = zipfile.ZipFile('webex.skill', 'w', zipfile.ZIP_DEFLATED); \ +z.write('skill/SKILL.md', 'webex-cli/SKILL.md'); \ +resources = ['admin','calling','cc','device','meetings','messaging']; \ +[z.write(f'skill/{r}/SKILL.md', f'webex-cli/resources/{r}.md') for r in resources]; \ +z.close()" + @echo "Built webex.skill" + clean: - rm -f webex webex-cli + rm -f webex webex-cli webex-mcp.dxt webex.skill rm -f codegen/api_spec.json codegen/api_outline.json diff --git a/README.md b/README.md index 8e1a23e..9f0067e 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,12 @@ webex login # Webex Calling webex calling people list --max 10 webex calling locations list -webex calling call-queue list +webex calling call-queue list-cxe # Contact Center webex cc site list webex cc team list -webex cc agents list +webex cc contact-service-queue list webex cc entry-point list # Admin @@ -91,11 +91,11 @@ All upload commands support `--dry-run` to preview the request without sending i ### Calling (`webex calling`) -45 resource groups including auto-attendants, call queues, hunt groups, call controls, call routing (dial plans, route groups, trunks), DECT devices, emergency services, locations, numbers, paging groups, people, workspaces, voicemail, recordings, and more. +47 resource groups including auto-attendants, call queues (CxE), hunt groups, call controls, call routing (dial plans, route groups, trunks), DECT devices, emergency services, locations, numbers, paging groups, people, workspaces, voicemail, converged recordings, and more. ### Contact Center (`webex cc`) -54 resource groups including agents, queues, entry points, flows, skills, desktop layouts, campaigns, callbacks, realtime stats, AI assistant, journey analytics, subscriptions, and more. +54 resource groups including sites, queues, entry points, teams, flows, skills, desktop layouts, global variables, business hours, auxiliary codes, campaigns, callbacks, realtime stats, AI assistant, journey analytics, subscriptions, and more. ### Admin (`webex admin`) @@ -103,11 +103,11 @@ All upload commands support `--dry-run` to preview the request without sending i ### Devices (`webex device`) -9 resource groups including devices, device configurations, workspaces, workspace locations/metrics/personalization, hot-desking, and xAPI (execute commands, query status). +10 resource groups including devices, device configurations, workspaces, workspace locations/metrics/personalization, hot-desking, and xAPI (execute commands, query status). ### Meetings (`webex meetings`) -22 resource groups including meetings, participants, recordings, transcripts, summaries, polls, Q&A, chats, invitees, preferences, session types, tracking codes, video mesh, and more. +23 resource groups including meetings, participants, recordings, transcripts, summaries, polls, Q&A, chats, invitees, preferences, session types, tracking codes, video mesh, and more. ### Messaging (`webex messaging`) @@ -166,7 +166,7 @@ Control output with `--output`: ```bash webex calling people list --output table -webex cc agents list --output csv > agents.csv +webex cc users list --output csv > users.csv ``` ## Global Flags @@ -192,11 +192,87 @@ webex config get client-id # View current value Config is stored in `~/.webex-cli/config.json`. +## MCP Server + +> **Claude Desktop users:** see [CLAUDE_DESKTOP.md](CLAUDE_DESKTOP.md) for installation, DXT extension setup, and skill configuration specific to Claude Desktop. + + +`webex mcp serve` starts a [Model Context Protocol](https://modelcontextprotocol.io/) server over stdio, letting AI clients query and manage your Webex environment directly. + +```bash +# Register with Claude Code +claude mcp add webex -- webex mcp serve + +# Or register with a specific binary path +claude mcp add webex -- /path/to/webex mcp serve +``` + +The server exposes 4 tools: + +| Tool | API methods | Description | +|---|---|---| +| `webex_read` | GET | Execute a read-only CLI command (list, get, download, export, search) | +| `webex_write` | POST / PUT / PATCH / DELETE | Execute a command that creates, updates, or deletes a resource | +| `webex_help` | — | Get help text for any command or command group | +| `webex_usage` | — | Query the MCP usage log (recent commands, timing, status) | + +Read and write operations are split into separate tools so that `webex_read` can be auto-approved in permissions while `webex_write` always prompts for confirmation. + +And 2 MCP resources: + +| Resource | Description | +|---|---| +| `webex://commands` | JSON array of all available CLI commands with short descriptions | +| `webex://usage` | Last 50 raw lines of the usage log | + +Rather than exposing fixed per-API tools, the dispatcher pattern lets AI clients invoke the full CLI surface via `webex_run` — the command tree expands automatically as new commands are added. + +Auth is shared with the CLI — run `webex login` once and the MCP server uses the same stored credentials. Token refresh is handled automatically. + +### Usage Log + +All `webex_run` invocations are logged to `~/.webex-mcp/usage.log` (JSONL). Configure with serve flags: + +```bash +webex mcp serve --log-path /tmp/webex.log --log-max-size 10485760 --log-max-files 5 +``` + +| Flag | Default | Description | +|---|---|---| +| `--log-path` | `~/.webex-mcp/usage.log` | Log file path | +| `--log-max-size` | `5242880` (5 MB) | Max file size before rotation | +| `--log-max-files` | `3` | Number of rotated files to keep | + +### Team Distribution via Claude Admin Portal + +Package the extension once and upload it to the Claude admin console — Claude Desktop installs it automatically for all team members. Each user's local `webex` installation and credentials are used; no shared server is needed. + +```bash +make extension # produces webex-mcp.dxt +``` + +1. Upload `webex-mcp.dxt` to the Claude admin portal under **Extensions** +2. Enable it for your team or org +3. Team members must have `webex` installed and authenticated (`webex login`) + +Alternatively, team members can install the extension locally by double-clicking `webex-mcp.dxt` in Finder. + ## Coding Agent Skill -A skill file is included in `skill/SKILL.md` that enables AI coding agents (Claude Code, Claude Cowork, OpenAI Codex, Cursor) to query and manage your Webex environment. +A set of skill files in `skill/` enables AI coding agents (Claude Code, Claude Cowork, OpenAI Codex, Cursor) to use the CLI via natural language. The root skill (`skill/SKILL.md`) covers auth, command structure, and global flags. Six per-area sub-skills provide comprehensive flag and body-schema documentation for each CLI area: + +| Area | Sub-skill | +|---|---| +| Admin | `skill/admin/SKILL.md` | +| Calling | `skill/calling/SKILL.md` | +| Contact Center | `skill/cc/SKILL.md` | +| Devices | `skill/device/SKILL.md` | +| Meetings | `skill/meetings/SKILL.md` | +| Messaging | `skill/messaging/SKILL.md` | + +Each sub-skill also contains an auto-generated **Command Reference** section (updated by `make codegen`) that lists every command and its flags, keeping documentation in sync with the API as Postman collections change. -The installer and `webex post-install` command will offer to install the skill automatically. Skills are also kept up to date when you run `webex update`. +`webex post-install` offers to install all skill files automatically. They are also updated by `webex update`. See the [docs](https://cloverhound.github.io/webex-cli/agent-skill/) for manual setup instructions. @@ -204,7 +280,7 @@ See the [docs](https://cloverhound.github.io/webex-cli/agent-skill/) for manual See [CLAUDE.md](CLAUDE.md) for project structure and development workflow. -Commands in `cmd/calling/` and `cmd/cc/` are **generated** from Postman collections — do not edit by hand. See the [code generation pipeline](CLAUDE.md#code-generation-pipeline) for details. +Commands in `cmd/calling/`, `cmd/cc/`, and the other area packages are **generated** from Postman collections — do not edit by hand. Run `make refresh` to re-download collections, regenerate Go files, update skill documentation, and rebuild. See the [code generation pipeline](CLAUDE.md#code-generation-pipeline) for details. ## License diff --git a/Webex--Cloverhound-Icons.svg b/Webex--Cloverhound-Icons.svg new file mode 100644 index 0000000..f2045c8 --- /dev/null +++ b/Webex--Cloverhound-Icons.svg @@ -0,0 +1,8 @@ + + + Webex Cloverhound Icon + + Webex + + + diff --git a/cmd/admin/events.go b/cmd/admin/events.go index 00253e4..a2bad38 100644 --- a/cmd/admin/events.go +++ b/cmd/admin/events.go @@ -34,6 +34,7 @@ func init() { var from string var to string var max string + var serviceType string var last string cmd := &cobra.Command{ Use: "list", @@ -56,6 +57,7 @@ Long result sets will be split into [pages](/docs/basics#pagination).`, req.QueryParam("from", from) req.QueryParam("to", to) req.QueryParam("max", max) + req.QueryParam("serviceType", serviceType) if config.Paginate() { resp, statusCode, err := req.DoPaginated(true) if err != nil { @@ -76,6 +78,7 @@ Long result sets will be split into [pages](/docs/basics#pagination).`, cmd.Flags().StringVar(&from, "from", "", "List events which occurred after a specific date and time.") cmd.Flags().StringVar(&to, "to", "", "List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time.") cmd.Flags().StringVar(&max, "max", "", "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.") + cmd.Flags().StringVar(&serviceType, "service-type", "", "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.") cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") eventsCmd.AddCommand(cmd) } diff --git a/cmd/admin/partner_administrators.go b/cmd/admin/partner_administrators.go index cde3740..251ba3e 100644 --- a/cmd/admin/partner_administrators.go +++ b/cmd/admin/partner_administrators.go @@ -30,7 +30,7 @@ func init() { cmd := &cobra.Command{ Use: "get-all-customers-managed-admin", Short: "Get all customers managed by a partner admin", - Long: "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default.\n\nThis API can be invoked by Partner Full Admin and Partner Readonly Admin.\nSpecify the `personId` in the `managedBy` parameter in the URI.", + Long: "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default. This does not include customers managed through Customer Groups.\n\nThis API can be invoked by Partner Full Admin and Partner Readonly Admin.\nSpecify the `personId` in the `managedBy` parameter in the URI.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/partner/organizations") req.QueryParam("managedBy", managedBy) @@ -57,7 +57,7 @@ func init() { cmd := &cobra.Command{ Use: "get-all-admins-assigned-customer", Short: "Get all partner admins assigned to a customer", - Long: "For a given customer, get all the partner admins with their role details.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter.", + Long: "For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/partner/organizations/{orgId}/partnerAdmins") req.PathParam("orgId", orgId) @@ -111,7 +111,7 @@ func init() { cmd := &cobra.Command{ Use: "unassign-admin-customer", Short: "Unassign partner admin from a customer", - Long: "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", + Long: "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user. If a partner admin is also managing the customer organization through a Customer Group, they will continue to have access.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "DELETE", "/partner/organizations/{orgId}/partnerAdmin/{personId}/unassign") req.PathParam("orgId", orgId) diff --git a/cmd/admin/people.go b/cmd/admin/people.go index c85f295..aaeb56a 100644 --- a/cmd/admin/people.go +++ b/cmd/admin/people.go @@ -40,7 +40,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List People", - Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/people") req.QueryParam("email", email) diff --git a/cmd/admin/scim_2_users.go b/cmd/admin/scim_2_users.go index 94f28d6..c1a9ed8 100644 --- a/cmd/admin/scim_2_users.go +++ b/cmd/admin/scim_2_users.go @@ -34,7 +34,7 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create a user", - Long: "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n\u2022 urn:ietf:params:scim:schemas:core:2.0:User\n\n\u2022 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n\u2022 urn:scim:schemas:extension:cisco:webexidentity:2.0:User\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.", + Long: "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n\u2022 urn:ietf:params:scim:schemas:core:2.0:User\n\n\u2022 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n\u2022 urn:scim:schemas:extension:cisco:webexidentity:2.0:User\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/identity/scim/{orgId}/v2/Users") req.PathParam("orgId", orgId) @@ -193,7 +193,7 @@ func init() { cmd := &cobra.Command{ Use: "update-patch", Short: "Update a user with PATCH", - Long: "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`.\nThe result of the add operation depends upon the target `path` reference locations:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`.\nThe operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will return failure as HTTP status code 400 and a `scimType` error code of \"noTarget\".\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute's sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.", + Long: "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`.\nThe result of the add operation depends upon the target `path` reference locations:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`.\nThe operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will return failure as HTTP status code 400 and a `scimType` error code of \"noTarget\".\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute's sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PATCH", "/identity/scim/{orgId}/v2/Users/{userId}") req.PathParam("orgId", orgId) diff --git a/cmd/calling/announcement_repository.go b/cmd/calling/announcement_repository.go index 6952151..21bf5a5 100644 --- a/cmd/calling/announcement_repository.go +++ b/cmd/calling/announcement_repository.go @@ -252,4 +252,130 @@ func init() { announcementRepositoryCmd.AddCommand(cmd) } + { // generate-text-to-speech-prompt + var orgId string + var voice string + var text string + var languageCode string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "generate-text-to-speech-prompt", + Short: "Generate a Text-to-Speech Prompt", + Long: "Generate a text-to-speech prompt from the provided text, voice, and language.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/textToSpeech/actions/generate/invoke") + req.QueryParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("voice", voice) + req.BodyString("text", text) + req.BodyString("languageCode", languageCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "Generate text-to-speech for this organization.") + cmd.Flags().StringVar(&voice, "voice", "", "") + cmd.Flags().StringVar(&text, "text", "", "") + cmd.Flags().StringVar(&languageCode, "language-code", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + announcementRepositoryCmd.AddCommand(cmd) + } + + { // get-text-to-speech-usage + var orgId string + cmd := &cobra.Command{ + Use: "get-text-to-speech-usage", + Short: "Get Text-to-Speech Usage", + Long: "Retrieve text-to-speech usage information, including the number of API calls made, the maximum allowed within the time window, and the timestamp indicating when the usage will reset.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/textToSpeech/usage") + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "Get text-to-speech usage for this organization.") + announcementRepositoryCmd.AddCommand(cmd) + } + + { // get-text-to-speech-generation-status + var ttsId string + var orgId string + cmd := &cobra.Command{ + Use: "get-text-to-speech-generation-status", + Short: "Get Text-to-Speech Generation Status", + Long: "Get the status of a text-to-speech generation request by its ID. If the status is SUCCESS, the response includes `promptUrl`, `kmsKeyUri`, and `fileUri` to preview or use the audio prompt.\n\nTo preview the audio prompt:\n\n1. Download the KMS key - use the Webex Node.js SDK and provide `kmsKeyUri` to download the key from KMS.\n\n2. Download the encrypted audio - The encrypted audio file content is stored in cloud and can be retrieved using `promptURL`.\n\n3. Decrypt the audio content - Use the jose library to decrypt the content downloaded from `promptUrl` using the downloaded key.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/textToSpeech/{ttsId}") + req.PathParam("ttsId", ttsId) + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&ttsId, "tts-id", "", "Unique identifier of the text-to-speech generation request.") + cmd.MarkFlagRequired("tts-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Get text-to-speech status for this organization.") + announcementRepositoryCmd.AddCommand(cmd) + } + + { // list-text-to-speech-voices + var orgId string + cmd := &cobra.Command{ + Use: "list-text-to-speech-voices", + Short: "List Text-to-Speech Voices", + Long: "Fetch a list of available text-to-speech voices. Use the returned voice ID in the generation request.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/textToSpeech/voices") + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "List text-to-speech voices supported for this organization.") + announcementRepositoryCmd.AddCommand(cmd) + } + } diff --git a/cmd/calling/auto_attendant.go b/cmd/calling/auto_attendant.go index 07f4d7c..b4560f0 100644 --- a/cmd/calling/auto_attendant.go +++ b/cmd/calling/auto_attendant.go @@ -74,7 +74,7 @@ func init() { cmd := &cobra.Command{ Use: "get", Short: "Get Details for an Auto Attendant", - Long: "Retrieve an Auto Attendant details.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve an Auto Attendant details.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}") req.PathParam("locationId", locationId) @@ -111,7 +111,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update an Auto Attendant", - Long: "Update the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nUpdating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Update the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nUpdating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}") req.PathParam("locationId", locationId) @@ -177,7 +177,7 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create an Auto Attendant", - Long: "Create new Auto Attendant for the given location.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nCreating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Create new Auto Attendant for the given location.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nCreating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/autoAttendants") req.PathParam("locationId", locationId) @@ -577,7 +577,7 @@ Retrieving a selective call forwarding rule's settings for an auto attendant req cmd := &cobra.Command{ Use: "switch-mode-call-forward", Short: "Switch Mode for Call Forwarding Settings for an Auto Attendant", - Long: "Switches the current operating mode of the `Auto Attendant` to the mode as per normal operations.\n\nSwitching operating mode for an `auto attendant` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + Long: "Switches the current operating mode of the `Auto Attendant` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for an `auto attendant` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/autoAttendants/{autoAttendantId}/callForwarding/actions/switchMode/invoke") req.PathParam("locationId", locationId) diff --git a/cmd/calling/call_controls.go b/cmd/calling/call_controls.go index 5f0ba1a..6172368 100644 --- a/cmd/calling/call_controls.go +++ b/cmd/calling/call_controls.go @@ -28,6 +28,7 @@ func init() { { // dial var destination string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -46,6 +47,7 @@ func init() { } else { req.BodyString("destination", destination) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -57,6 +59,7 @@ func init() { } cmd.Flags().StringVar(&destination, "destination", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -440,6 +443,7 @@ func init() { { // get var destination string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -458,6 +462,7 @@ func init() { } else { req.BodyString("destination", destination) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -469,6 +474,7 @@ func init() { } cmd.Flags().StringVar(&destination, "destination", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -691,6 +697,7 @@ func init() { { // pickup var target string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -709,6 +716,7 @@ func init() { } else { req.BodyString("target", target) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -720,6 +728,7 @@ func init() { } cmd.Flags().StringVar(&target, "target", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -729,6 +738,7 @@ func init() { { // barge var target string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -747,6 +757,7 @@ func init() { } else { req.BodyString("target", target) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -758,6 +769,7 @@ func init() { } cmd.Flags().StringVar(&target, "target", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -854,6 +866,7 @@ func init() { var orgId string var destination string var endpointId string + var singleNumberReachPhoneNumber string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -873,6 +886,7 @@ func init() { } else { req.BodyString("destination", destination) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) } resp, statusCode, err := req.Do() if err != nil { @@ -886,6 +900,7 @@ func init() { cmd.Flags().StringVar(&orgId, "org-id", "", "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization.") cmd.Flags().StringVar(&destination, "destination", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") callControlsCmd.AddCommand(cmd) diff --git a/cmd/calling/call_queue.go b/cmd/calling/call_queue.go index 2195565..888b19a 100644 --- a/cmd/calling/call_queue.go +++ b/cmd/calling/call_queue.go @@ -27,7 +27,7 @@ var callQueueCmd = &cobra.Command{ func init() { cmd.CallingCmd.AddCommand(callQueueCmd) - { // list-cxe + { // list-customer-assist var orgId string var locationId string var max string @@ -38,8 +38,8 @@ func init() { var departmentName string var hasCxEssentials string cmd := &cobra.Command{ - Use: "list-cxe", - Short: "Read the List of Call Queues with Customer Experience Essentials", + Use: "list-customer-assist", + Short: "Read the List of Call Queues with Customer Assist", Long: "List all Call Queues for the organization.\n\nCall queues temporarily hold calls in the cloud, when all agents\nassigned to receive calls from the queue are unavailable. Queued calls are routed to \nan available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach the users assigned to the call queue.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/queues") @@ -74,20 +74,20 @@ func init() { cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Returns only the call queues matching the given primary phone number or extension.") cmd.Flags().StringVar(&departmentId, "department-id", "", "Returns only call queues matching the given department ID.") cmd.Flags().StringVar(&departmentName, "department-name", "", "Returns only call queues matching the given department name.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.") callQueueCmd.AddCommand(cmd) } - { // create-cxe + { // create-customer-assist var locationId string var orgId string var hasCxEssentials string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "create-cxe", - Short: "Create a Call Queue with Customer Experience Essentials", - Long: "Create new Call Queues for the given location.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nCreating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Use: "create-customer-assist", + Short: "Create a Call Queue with Customer Assist", + Long: "Create new Call Queues for the given location.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nCreating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/queues") req.PathParam("locationId", locationId) @@ -110,7 +110,7 @@ func init() { cmd.Flags().StringVar(&locationId, "location-id", "", "The location ID where the call queue needs to be created.") cmd.MarkFlagRequired("location-id") cmd.Flags().StringVar(&orgId, "org-id", "", "The organization ID where the call queue needs to be created.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") callQueueCmd.AddCommand(cmd) @@ -144,15 +144,15 @@ func init() { callQueueCmd.AddCommand(cmd) } - { // get-cxe + { // get-customer-assist var locationId string var queueId string var orgId string var hasCxEssentials string cmd := &cobra.Command{ - Use: "get-cxe", - Short: "Get Details for a Call Queue with Customer Experience Essentials", - Long: "Retrieve Call Queue details.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nRetrieving call queue details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Use: "get-customer-assist", + Short: "Get Details for a Call Queue with Customer Assist", + Long: "Retrieve Call Queue details.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nRetrieving call queue details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/queues/{queueId}") req.PathParam("locationId", locationId) @@ -178,7 +178,7 @@ func init() { cmd.Flags().StringVar(&queueId, "queue-id", "", "Retrieves the details of call queue with this identifier.") cmd.MarkFlagRequired("queue-id") cmd.Flags().StringVar(&orgId, "org-id", "", "Retrieves the details of a call queue in this organization.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.") callQueueCmd.AddCommand(cmd) } @@ -191,7 +191,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Call Queue", - Long: "Update the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users assigned to the call queue.\n\nUpdating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Update the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users assigned to the call queue.\n\nUpdating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/queues/{queueId}") req.PathParam("locationId", locationId) @@ -706,7 +706,7 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "update-forced-forward-service", - Short: "Update a Call Queue Forced Forward service", + Short: "Update a Call Queue Forced Forward Service", Long: "Update the designated Forced Forward Service.\n\nIf the option is enabled, then incoming calls to the queue are forwarded to the configured destination. Calls that are already in the queue remain queued.\nThe policy can be configured to play an announcement prior to proceeding with the forward.\n\nUpdating a call queue Forced Forward service requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/queues/{queueId}/forcedForward") @@ -780,7 +780,7 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "update-stranded-service", - Short: "Update a Call Queue Stranded Calls service", + Short: "Update a Call Queue Stranded Calls Service", Long: "Update the designated Call Stranded Calls Service.\n\nAllow admin to modify configured Stranded Calls settings.\n\nUpdating a call queue stranded calls requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/queues/{queueId}/strandedCalls") @@ -985,7 +985,7 @@ func init() { callQueueCmd.AddCommand(cmd) } - { // list-supervisors-cxe + { // list-supervisors-customer-assist var orgId string var max string var start string @@ -994,8 +994,8 @@ func init() { var order string var hasCxEssentials string cmd := &cobra.Command{ - Use: "list-supervisors-cxe", - Short: "Get List of Supervisors with Customer Experience Essentials", + Use: "list-supervisors-customer-assist", + Short: "Get List of Supervisors with Customer Assist", Long: "Get list of supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nRequires a full, location, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/supervisors") @@ -1026,18 +1026,18 @@ func init() { cmd.Flags().StringVar(&name, "name", "", "Only return the supervisors that match the given name.") cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Only return the supervisors that match the given phone number, extension, or ESN.") cmd.Flags().StringVar(&order, "order", "", "Sort results alphabetically by supervisor name, in ascending or descending order.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.") callQueueCmd.AddCommand(cmd) } - { // create-supervisor-cxe + { // create-supervisor-customer-assist var orgId string var hasCxEssentials string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "create-supervisor-cxe", - Short: "Create a Supervisor with Customer Experience Essentials", + Use: "create-supervisor-customer-assist", + Short: "Create a Supervisor with Customer Assist", Long: "Create a new supervisor. The supervisor must be created with at least one agent.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/supervisors") @@ -1058,7 +1058,7 @@ func init() { }, } cmd.Flags().StringVar(&orgId, "org-id", "", "The organization ID where the supervisor needs to be created.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") callQueueCmd.AddCommand(cmd) @@ -1072,7 +1072,7 @@ func init() { var bodyFile string cmd := &cobra.Command{ Use: "delete-bulk-supervisors", - Short: "Delete Bulk supervisors", + Short: "Delete Bulk Supervisors", Long: "Deletes supervisors in bulk from an organization.\n\nSupervisors are users who manage agents and who perform functions including monitoring, coaching, and more.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "DELETE", "/telephony/config/supervisors") @@ -1107,7 +1107,7 @@ func init() { var orgId string cmd := &cobra.Command{ Use: "delete-supervisor", - Short: "Delete A Supervisor", + Short: "Delete a Supervisor", Long: "Deletes the supervisor from an organization.\n\nSupervisors are users who manage agents and who perform functions including monitoring, coaching, and more.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "DELETE", "/telephony/config/supervisors/{supervisorId}") @@ -1126,7 +1126,7 @@ func init() { callQueueCmd.AddCommand(cmd) } - { // supervisor-detail-cxe + { // get-supervisor-detail-customer-assist var supervisorId string var orgId string var max string @@ -1136,8 +1136,8 @@ func init() { var order string var hasCxEssentials string cmd := &cobra.Command{ - Use: "supervisor-detail-cxe", - Short: "GET Supervisor Detail with Customer Experience Essentials", + Use: "get-supervisor-detail-customer-assist", + Short: "Get Supervisor Detail with Customer Assist", Long: "Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/supervisors/{supervisorId}") @@ -1171,19 +1171,19 @@ func init() { cmd.Flags().StringVar(&name, "name", "", "Only return the agents that match the given name.") cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Only return agents that match the given phone number, extension, or ESN.") cmd.Flags().StringVar(&order, "order", "", "Sort results alphabetically by supervisor name, in ascending or descending order.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.") callQueueCmd.AddCommand(cmd) } - { // assign-unassign-agents-supervisor-cxe + { // assign-unassign-agents-supervisor-customer-assist var supervisorId string var orgId string var hasCxEssentials string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "assign-unassign-agents-supervisor-cxe", - Short: "Assign or Unassign Agents to Supervisor with Customer Experience Essentials", + Use: "assign-unassign-agents-supervisor-customer-assist", + Short: "Assign or Unassign Agents to Supervisor with Customer Assist", Long: "Assign or unassign agents to the supervisor for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/supervisors/{supervisorId}") @@ -1207,13 +1207,13 @@ func init() { cmd.Flags().StringVar(&supervisorId, "supervisor-id", "", "Identifier of the supervisor to be updated.") cmd.MarkFlagRequired("supervisor-id") cmd.Flags().StringVar(&orgId, "org-id", "", "Assign or unassign agents to a supervisor in this organization.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") callQueueCmd.AddCommand(cmd) } - { // list-available-supervisors-cxe + { // list-available-supervisors-customer-assist var orgId string var max string var start string @@ -1222,8 +1222,8 @@ func init() { var order string var hasCxEssentials string cmd := &cobra.Command{ - Use: "list-available-supervisors-cxe", - Short: "List Available Supervisors with Customer Experience Essentials", + Use: "list-available-supervisors-customer-assist", + Short: "List Available Supervisors with Customer Assist", Long: "Get list of available supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/supervisors/availableSupervisors") @@ -1254,11 +1254,11 @@ func init() { cmd.Flags().StringVar(&name, "name", "", "Only return the supervisors that match the given name.") cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Only return the supervisors that match the given phone number, extension, or ESN.") cmd.Flags().StringVar(&order, "order", "", "Sort results alphabetically by supervisor name, in ascending or descending order.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.") callQueueCmd.AddCommand(cmd) } - { // list-available-agents-cxe + { // list-available-agents-customer-assist var orgId string var max string var start string @@ -1267,8 +1267,8 @@ func init() { var order string var hasCxEssentials string cmd := &cobra.Command{ - Use: "list-available-agents-cxe", - Short: "List Available Agents with Customer Experience Essentials", + Use: "list-available-agents-customer-assist", + Short: "List Available Agents with Customer Assist", Long: "Get list of available agents for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/supervisors/availableAgents") @@ -1299,11 +1299,11 @@ func init() { cmd.Flags().StringVar(&name, "name", "", "Returns only the agents that match the given name.") cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Returns only the agents that match the phone number, extension, or ESN.") cmd.Flags().StringVar(&order, "order", "", "Sort results alphabetically by supervisor name, in ascending or descending order.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.") callQueueCmd.AddCommand(cmd) } - { // list-agents-cxe + { // list-agents-customer-assist var orgId string var locationId string var queueId string @@ -1315,8 +1315,8 @@ func init() { var hasCxEssentials string var order string cmd := &cobra.Command{ - Use: "list-agents-cxe", - Short: "Read the List of Call Queue Agents with Customer Experience Essentials", + Use: "list-agents-customer-assist", + Short: "Read the List of Call Queue Agents with Customer Assist", Long: "List all Call Queues Agents for the organization.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The decoded value of the agent's `id`, and the `type` returned in the response, are always returned as `PEOPLE`, even when the agent is a workspace or virtual line. This will be addressed in a future release.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/queues/agents") @@ -1352,20 +1352,20 @@ func init() { cmd.Flags().StringVar(&name, "name", "", "Returns only the list of call queue agents that match the given name.") cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Returns only the list of call queue agents that match the given phone number or extension.") cmd.Flags().StringVar(&joinEnabled, "join-enabled", "", "Returns only the list of call queue agents that match the given `joinEnabled` value.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.") cmd.Flags().StringVar(&order, "order", "", "Sort results alphabetically by call queue agent's name, in ascending or descending order.") callQueueCmd.AddCommand(cmd) } - { // get-agent-cxe + { // get-agent-customer-assist var id string var orgId string var hasCxEssentials string var max string var start string cmd := &cobra.Command{ - Use: "get-agent-cxe", - Short: "Get Details for a Call Queue Agent with Customer Experience Essentials", + Use: "get-agent-customer-assist", + Short: "Get Details for a Call Queue Agent with Customer Assist", Long: "Retrieve details of a particular Call queue agent based on the agent ID.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving a call queue agent's details require a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The agent's `type` returned in the response and in the decoded value of the agent's `id`, is always of type `PEOPLE`, even if the agent is a workspace or virtual line. This` will be corrected in a future release.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/queues/agents/{id}") @@ -1391,21 +1391,21 @@ func init() { cmd.Flags().StringVar(&id, "id", "", "Retrieve call queue agents with this identifier.") cmd.MarkFlagRequired("id") cmd.Flags().StringVar(&orgId, "org-id", "", "Retrieve call queue agents from this organization.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.") cmd.Flags().StringVar(&max, "max", "", "Limit the number of objects returned to this maximum count.") cmd.Flags().StringVar(&start, "start", "", "Start at the zero-based offset in the list of matching objects.") callQueueCmd.AddCommand(cmd) } - { // update-agent-settings-one-more-cxe + { // update-agent-settings-one-more-customer-assist var id string var orgId string var hasCxEssentials string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "update-agent-settings-one-more-cxe", - Short: "Update an Agent's Settings of One or More Call Queues with Customer Experience Essentials", + Use: "update-agent-settings-one-more-customer-assist", + Short: "Update an Agent's Settings of One or More Call Queues with Customer Assist", Long: "Modify an agent's call queue settings for an organization.\n\nCalls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nThis operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/queues/agents/{id}/settings") @@ -1429,7 +1429,7 @@ func init() { cmd.Flags().StringVar(&id, "id", "", "Identifier of the agent to be updated.") cmd.MarkFlagRequired("id") cmd.Flags().StringVar(&orgId, "org-id", "", "Update the settings of an agent in this organization.") - cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") callQueueCmd.AddCommand(cmd) @@ -1444,7 +1444,7 @@ func init() { cmd := &cobra.Command{ Use: "switch-mode-forward", Short: "Switch Mode for Call Forwarding Settings for a Call Queue", - Long: "Switches the current operating mode of the `Call Queue` to the mode as per normal operations.\n\nSwitching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + Long: "Switches the current operating mode of the `Call Queue` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/actions/switchMode/invoke") req.PathParam("locationId", locationId) diff --git a/cmd/calling/call_settings_for_me.go b/cmd/calling/call_settings_for_me.go index 678ccaa..6c29f93 100644 --- a/cmd/calling/call_settings_for_me.go +++ b/cmd/calling/call_settings_for_me.go @@ -6125,4 +6125,235 @@ func init() { callSettingsForMeCmd.AddCommand(cmd) } + { // get-personal-assistant + cmd := &cobra.Command{ + Use: "get-personal-assistant", + Short: "Get Personal Assistant Settings", + Long: "Retrieve personal assistant settings for a person. The personal assistant feature allows users to configure an automated attendant that can handle incoming calls when they are unavailable, including presence-based routing and call transfer options.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/people/me/settings/personalAssistant") + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + callSettingsForMeCmd.AddCommand(cmd) + } + + { // update-personal-assistant + var enabled bool + var presence string + var untilDateTime string + var transferEnabled bool + var transferNumber string + var alerting string + var alertMeFirstNumberOfRings int64 + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-personal-assistant", + Short: "Update Personal Assistant Settings", + Long: "Update personal assistant settings for a person. Allows configuring the personal assistant feature including enabling/disabling it, setting presence status, configuring call transfer options, and alerting preferences.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/people/me/settings/personalAssistant") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyBool("enabled", enabled, cmd.Flags().Changed("enabled")) + req.BodyString("presence", presence) + req.BodyString("untilDateTime", untilDateTime) + req.BodyBool("transferEnabled", transferEnabled, cmd.Flags().Changed("transfer-enabled")) + req.BodyString("transferNumber", transferNumber) + req.BodyString("alerting", alerting) + req.BodyInt("alertMeFirstNumberOfRings", alertMeFirstNumberOfRings, cmd.Flags().Changed("alert-me-first-number-of-rings")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().BoolVar(&enabled, "enabled", false, "") + cmd.Flags().StringVar(&presence, "presence", "", "") + cmd.Flags().StringVar(&untilDateTime, "until-date-time", "", "") + cmd.Flags().BoolVar(&transferEnabled, "transfer-enabled", false, "") + cmd.Flags().StringVar(&transferNumber, "transfer-number", "", "") + cmd.Flags().StringVar(&alerting, "alerting", "", "") + cmd.Flags().Int64Var(&alertMeFirstNumberOfRings, "alert-me-first-number-of-rings", 0, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + callSettingsForMeCmd.AddCommand(cmd) + } + + { // get-person-voicemail-rules + cmd := &cobra.Command{ + Use: "get-person-voicemail-rules", + Short: "Get Person's Voicemail Rules", + Long: "Get person's voicemail passcode rules. Voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.\n\nThe voicemail feature allows users to manage their voicemail settings as part of Webex Calling. Voicemail rules help ensure secure access to voice messages by defining passcode complexity requirements.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/people/me/voicemail/rules") + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + callSettingsForMeCmd.AddCommand(cmd) + } + + { // update-voicemail-pin + var passcode string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-voicemail-pin", + Short: "Update Voicemail PIN", + Long: "Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply with the passcode rules defined for the organization.\n\nThe voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN. The PIN is required to retrieve voice messages via phone.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/people/me/voicemail/pin") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("passcode", passcode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&passcode, "passcode", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + callSettingsForMeCmd.AddCommand(cmd) + } + + { // get-hoteling-guest + cmd := &cobra.Command{ + Use: "get-hoteling-guest", + Short: "Get Hoteling Guest Settings", + Long: "Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as a guest, associating their extension and configuration with that device for a limited time. This API returns the current hoteling guest configuration including any active host association details.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/people/me/settings/hoteling/guest") + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + callSettingsForMeCmd.AddCommand(cmd) + } + + { // update-hoteling-guest + var enabled bool + var associationLimitEnabled bool + var associationLimitHours int64 + var hostId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-hoteling-guest", + Short: "Update Hoteling Guest Settings", + Long: "Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling as a guest, configuring whether an association will be removed automatically after a specified time period, and associating with a hoteling host.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/people/me/settings/hoteling/guest") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyBool("enabled", enabled, cmd.Flags().Changed("enabled")) + req.BodyBool("associationLimitEnabled", associationLimitEnabled, cmd.Flags().Changed("association-limit-enabled")) + req.BodyInt("associationLimitHours", associationLimitHours, cmd.Flags().Changed("association-limit-hours")) + req.BodyString("hostId", hostId) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().BoolVar(&enabled, "enabled", false, "") + cmd.Flags().BoolVar(&associationLimitEnabled, "association-limit-enabled", false, "") + cmd.Flags().Int64Var(&associationLimitHours, "association-limit-hours", 0, "") + cmd.Flags().StringVar(&hostId, "host-id", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + callSettingsForMeCmd.AddCommand(cmd) + } + + { // get-available-hoteling-hosts + var max string + var start string + var name string + var phoneNumber string + cmd := &cobra.Command{ + Use: "get-available-hoteling-hosts", + Short: "Get Available Hoteling Hosts", + Long: "Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by name or phone number and supports pagination.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/people/me/settings/hoteling/availableHosts") + req.QueryParam("max", max) + req.QueryParam("start", start) + req.QueryParam("name", name) + req.QueryParam("phoneNumber", phoneNumber) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&max, "max", "", "Limit the maximum number of hosts in the response. Default is 100.") + cmd.Flags().StringVar(&start, "start", "", "Start index for pagination. Default is 0.") + cmd.Flags().StringVar(&name, "name", "", "Filter hosts by name (first name or last name). Partial match is supported.") + cmd.Flags().StringVar(&phoneNumber, "phone-number", "", "Filter hosts by phone number. Partial match is supported.") + callSettingsForMeCmd.AddCommand(cmd) + } + } diff --git a/cmd/calling/calling_service.go b/cmd/calling/calling_service.go index dc10e7b..02e1fc1 100644 --- a/cmd/calling/calling_service.go +++ b/cmd/calling/calling_service.go @@ -28,12 +28,14 @@ func init() { cmd.CallingCmd.AddCommand(callingServiceCmd) { // list-announcement-languages + var ttsLanguage string cmd := &cobra.Command{ Use: "list-announcement-languages", Short: "Read the List of Announcement Languages", Long: "List all languages supported by Webex Calling for announcements and voice prompts.\n\nRetrieving announcement languages requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/announcementLanguages") + req.QueryParam("ttsLanguage", ttsLanguage) if config.Paginate() { resp, statusCode, err := req.DoPaginated(true) if err != nil { @@ -48,6 +50,7 @@ func init() { return output.Print(resp, statusCode) }, } + cmd.Flags().StringVar(&ttsLanguage, "tts-language", "", "Filter languages by TTS support.") callingServiceCmd.AddCommand(cmd) } diff --git a/cmd/calling/customer_assist.go b/cmd/calling/customer_assist.go new file mode 100644 index 0000000..591c2d5 --- /dev/null +++ b/cmd/calling/customer_assist.go @@ -0,0 +1,446 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package calling + +import ( + "fmt" + "strconv" + "strings" + + cmd "github.com/Cloverhound/webex-cli/cmd" + "github.com/Cloverhound/webex-cli/internal/client" + "github.com/Cloverhound/webex-cli/internal/config" + "github.com/Cloverhound/webex-cli/internal/output" + "github.com/spf13/cobra" +) + +// Ensure imports are used. +var _ = fmt.Sprintf +var _ = config.Token +var _ = output.Print +var _ = strconv.Itoa +var _ = strings.Join + +var customerAssistCmd = &cobra.Command{ + Use: "customer-assist", + Short: "CustomerAssist commands", +} + +func init() { + cmd.CallingCmd.AddCommand(customerAssistCmd) + + { // list-wrap-up-reasons + cmd := &cobra.Command{ + Use: "list-wrap-up-reasons", + Short: "List Wrap Up Reasons", + Long: "Return the list of wrap-up reasons configured for a customer.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues. Upon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue. Admins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the list of wrap-up reasons requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/cxEssentials/wrapup/reasons") + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + customerAssistCmd.AddCommand(cmd) + } + + { // create-wrap-up-reason + var name string + var description string + var queues []string + var assignAllQueuesEnabled bool + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create-wrap-up-reason", + Short: "Create Wrap Up Reason", + Long: "Create a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nCreating a wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/cxEssentials/wrapup/reasons") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("name", name) + req.BodyString("description", description) + req.BodyStringSlice("queues", queues) + req.BodyBool("assignAllQueuesEnabled", assignAllQueuesEnabled, cmd.Flags().Changed("assign-all-queues-enabled")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&name, "name", "", "") + cmd.Flags().StringVar(&description, "description", "", "") + cmd.Flags().StringSliceVar(&queues, "queues", nil, "") + cmd.Flags().BoolVar(&assignAllQueuesEnabled, "assign-all-queues-enabled", false, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + customerAssistCmd.AddCommand(cmd) + } + + { // get-wrap-up-reason + var wrapupReasonId string + cmd := &cobra.Command{ + Use: "get-wrap-up-reason", + Short: "Read Wrap Up Reason", + Long: "Return the wrap-up reason by ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the wrap-up reason by ID requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}") + req.PathParam("wrapupReasonId", wrapupReasonId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&wrapupReasonId, "wrapup-reason-id", "", "Wrap-up reason ID.") + cmd.MarkFlagRequired("wrapup-reason-id") + customerAssistCmd.AddCommand(cmd) + } + + { // update-wrap-up-reason + var wrapupReasonId string + var name string + var description string + var queuesToAssign []string + var queuesToUnassign []string + var assignAllQueuesEnabled bool + var unassignAllQueuesEnabled bool + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-wrap-up-reason", + Short: "Update Wrap Up Reason", + Long: "Modify a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nModifying a wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}") + req.PathParam("wrapupReasonId", wrapupReasonId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("name", name) + req.BodyString("description", description) + req.BodyStringSlice("queuesToAssign", queuesToAssign) + req.BodyStringSlice("queuesToUnassign", queuesToUnassign) + req.BodyBool("assignAllQueuesEnabled", assignAllQueuesEnabled, cmd.Flags().Changed("assign-all-queues-enabled")) + req.BodyBool("unassignAllQueuesEnabled", unassignAllQueuesEnabled, cmd.Flags().Changed("unassign-all-queues-enabled")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&wrapupReasonId, "wrapup-reason-id", "", "Wrap-up reason ID.") + cmd.MarkFlagRequired("wrapup-reason-id") + cmd.Flags().StringVar(&name, "name", "", "") + cmd.Flags().StringVar(&description, "description", "", "") + cmd.Flags().StringSliceVar(&queuesToAssign, "queues-to-assign", nil, "") + cmd.Flags().StringSliceVar(&queuesToUnassign, "queues-to-unassign", nil, "") + cmd.Flags().BoolVar(&assignAllQueuesEnabled, "assign-all-queues-enabled", false, "") + cmd.Flags().BoolVar(&unassignAllQueuesEnabled, "unassign-all-queues-enabled", false, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + customerAssistCmd.AddCommand(cmd) + } + + { // delete-wrap-up-reason + var wrapupReasonId string + cmd := &cobra.Command{ + Use: "delete-wrap-up-reason", + Short: "Delete Wrap Up Reason", + Long: "Delete a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nDeleting the wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "DELETE", "/telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}") + req.PathParam("wrapupReasonId", wrapupReasonId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&wrapupReasonId, "wrapup-reason-id", "", "Wrap-up reason ID.") + cmd.MarkFlagRequired("wrapup-reason-id") + customerAssistCmd.AddCommand(cmd) + } + + { // validate-wrap-up-reason + var name string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "validate-wrap-up-reason", + Short: "Validate Wrap Up Reason", + Long: "Validate the wrap-up reason name.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nValidating the wrap-up reason name requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke") + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("name", name) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&name, "name", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + customerAssistCmd.AddCommand(cmd) + } + + { // get-available-queues + var wrapupReasonId string + cmd := &cobra.Command{ + Use: "get-available-queues", + Short: "Read Available Queues", + Long: "Return the available queues for a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the available queues for a wrap-up reason requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/cxEssentials/wrapup/reasons/{wrapupReasonId}/availableQueues") + req.PathParam("wrapupReasonId", wrapupReasonId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&wrapupReasonId, "wrapup-reason-id", "", "Wrap-up reason ID.") + cmd.MarkFlagRequired("wrapup-reason-id") + customerAssistCmd.AddCommand(cmd) + } + + { // get-wrap-up-reason-settings + var locationId string + var queueId string + cmd := &cobra.Command{ + Use: "get-wrap-up-reason-settings", + Short: "Read Wrap Up Reason Settings", + Long: "Return a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the wrap-up reason by location ID and queue ID requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/cxEssentials/locations/{locationId}/queues/{queueId}/wrapup/settings") + req.PathParam("locationId", locationId) + req.PathParam("queueId", queueId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "The location ID.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&queueId, "queue-id", "", "The queue ID.") + cmd.MarkFlagRequired("queue-id") + customerAssistCmd.AddCommand(cmd) + } + + { // update-wrap-up-reason-settings + var locationId string + var queueId string + var wrapupReasons []string + var defaultWrapupReasonId string + var wrapupTimerEnabled bool + var wrapupTimer int64 + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-wrap-up-reason-settings", + Short: "Update Wrap Up Reason Settings", + Long: "Modify a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nModifying a wrap-up reason by location ID and queue ID requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/cxEssentials/locations/{locationId}/queues/{queueId}/wrapup/settings") + req.PathParam("locationId", locationId) + req.PathParam("queueId", queueId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyStringSlice("wrapupReasons", wrapupReasons) + req.BodyString("defaultWrapupReasonId", defaultWrapupReasonId) + req.BodyBool("wrapupTimerEnabled", wrapupTimerEnabled, cmd.Flags().Changed("wrapup-timer-enabled")) + req.BodyInt("wrapupTimer", wrapupTimer, cmd.Flags().Changed("wrapup-timer")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "The location ID.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&queueId, "queue-id", "", "The queue ID.") + cmd.MarkFlagRequired("queue-id") + cmd.Flags().StringSliceVar(&wrapupReasons, "wrapup-reasons", nil, "") + cmd.Flags().StringVar(&defaultWrapupReasonId, "default-wrapup-reason-id", "", "") + cmd.Flags().BoolVar(&wrapupTimerEnabled, "wrapup-timer-enabled", false, "") + cmd.Flags().Int64Var(&wrapupTimer, "wrapup-timer", 0, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + customerAssistCmd.AddCommand(cmd) + } + + { // get-screen-pop-configuration + var locationId string + var queueId string + var orgId string + cmd := &cobra.Command{ + Use: "get-screen-pop-configuration", + Short: "Read Screen Pop Configuration", + Long: "Returns the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nRetrieving the screen pop configuration requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/queues/{queueId}/cxEssentials/screenPop") + req.PathParam("locationId", locationId) + req.PathParam("queueId", queueId) + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "The location ID where the call queue resides.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&queueId, "queue-id", "", "The call queue ID for which screen pop configuration is modified.") + cmd.MarkFlagRequired("queue-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "The organization ID of the customer or partner's organization.") + customerAssistCmd.AddCommand(cmd) + } + + { // update-screen-pop-configuration + var locationId string + var queueId string + var orgId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-screen-pop-configuration", + Short: "Update Screen Pop Configuration", + Long: "Modifies the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nModifying the screen pop configuration requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/queues/{queueId}/cxEssentials/screenPop") + req.PathParam("locationId", locationId) + req.PathParam("queueId", queueId) + req.QueryParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "The location ID where the call queue resides.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&queueId, "queue-id", "", "The call queue ID for which screen pop configuration is modified.") + cmd.MarkFlagRequired("queue-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "The organization ID of the customer or partner's organization.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + customerAssistCmd.AddCommand(cmd) + } + + { // list-available-agents + var locationId string + var orgId string + var hasCxEssentials string + cmd := &cobra.Command{ + Use: "list-available-agents", + Short: "List Available Agents", + Long: "Return a list of available agents with Customer Assist license in a location.\n\nRetrieving the list of available agents requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/cxEssentials/agents/availableAgents") + req.PathParam("locationId", locationId) + req.QueryParam("orgId", orgId) + req.QueryParam("hasCxEssentials", hasCxEssentials) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "Retrieve the list of avaiilable agents in this location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "The organization ID of the customer or partner's organization.") + cmd.Flags().StringVar(&hasCxEssentials, "has-cx-essentials", "", "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.") + customerAssistCmd.AddCommand(cmd) + } + +} diff --git a/cmd/calling/devices.go b/cmd/calling/devices.go index 60d9a61..203e551 100644 --- a/cmd/calling/devices.go +++ b/cmd/calling/devices.go @@ -126,7 +126,7 @@ func init() { cmd := &cobra.Command{ Use: "create-mac-address", Short: "Create a Device by MAC Address", - Long: "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + Long: "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/devices") req.QueryParam("orgId", orgId) @@ -271,7 +271,7 @@ func init() { cmd := &cobra.Command{ Use: "create-activation-code", Short: "Create a Device Activation Code", - Long: "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + Long: "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/devices/activationCode") req.QueryParam("orgId", orgId) diff --git a/cmd/calling/emergency_services.go b/cmd/calling/emergency_services.go index 4bd763b..698c984 100644 --- a/cmd/calling/emergency_services.go +++ b/cmd/calling/emergency_services.go @@ -661,6 +661,8 @@ func init() { var orgId string var selected string var locationMemberId string + var elinEnabled bool + var elinForWebexAppEnabled bool var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -680,6 +682,8 @@ func init() { } else { req.BodyString("selected", selected) req.BodyString("locationMemberId", locationMemberId) + req.BodyBool("elinEnabled", elinEnabled, cmd.Flags().Changed("elin-enabled")) + req.BodyBool("elinForWebexAppEnabled", elinForWebexAppEnabled, cmd.Flags().Changed("elin-for-webex-app-enabled")) } resp, statusCode, err := req.Do() if err != nil { @@ -693,6 +697,8 @@ func init() { cmd.Flags().StringVar(&orgId, "org-id", "", "ID of the organization within which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.") cmd.Flags().StringVar(&selected, "selected", "", "") cmd.Flags().StringVar(&locationMemberId, "location-member-id", "", "") + cmd.Flags().BoolVar(&elinEnabled, "elin-enabled", false, "") + cmd.Flags().BoolVar(&elinForWebexAppEnabled, "elin-for-webex-app-enabled", false, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") emergencyServicesCmd.AddCommand(cmd) @@ -765,6 +771,7 @@ func init() { var orgId string var selected string var locationMemberId string + var elinEnabled bool var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -784,6 +791,7 @@ func init() { } else { req.BodyString("selected", selected) req.BodyString("locationMemberId", locationMemberId) + req.BodyBool("elinEnabled", elinEnabled, cmd.Flags().Changed("elin-enabled")) } resp, statusCode, err := req.Do() if err != nil { @@ -797,6 +805,7 @@ func init() { cmd.Flags().StringVar(&orgId, "org-id", "", "Updating Emergency Callback Number attributes for this organization.") cmd.Flags().StringVar(&selected, "selected", "", "") cmd.Flags().StringVar(&locationMemberId, "location-member-id", "", "") + cmd.Flags().BoolVar(&elinEnabled, "elin-enabled", false, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") emergencyServicesCmd.AddCommand(cmd) diff --git a/cmd/calling/external_voicemail.go b/cmd/calling/external_voicemail.go index 9c9fe61..acffd3e 100644 --- a/cmd/calling/external_voicemail.go +++ b/cmd/calling/external_voicemail.go @@ -28,6 +28,7 @@ func init() { { // dial var destination string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -46,6 +47,7 @@ func init() { } else { req.BodyString("destination", destination) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -57,6 +59,7 @@ func init() { } cmd.Flags().StringVar(&destination, "destination", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -440,6 +443,7 @@ func init() { { // get var destination string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -458,6 +462,7 @@ func init() { } else { req.BodyString("destination", destination) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -469,6 +474,7 @@ func init() { } cmd.Flags().StringVar(&destination, "destination", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -691,6 +697,7 @@ func init() { { // pickup var target string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -709,6 +716,7 @@ func init() { } else { req.BodyString("target", target) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -720,6 +728,7 @@ func init() { } cmd.Flags().StringVar(&target, "target", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") @@ -729,6 +738,7 @@ func init() { { // barge var target string var endpointId string + var singleNumberReachPhoneNumber string var lineOwnerId string var bodyRaw string var bodyFile string @@ -747,6 +757,7 @@ func init() { } else { req.BodyString("target", target) req.BodyString("endpointId", endpointId) + req.BodyString("singleNumberReachPhoneNumber", singleNumberReachPhoneNumber) req.BodyString("lineOwnerId", lineOwnerId) } resp, statusCode, err := req.Do() @@ -758,6 +769,7 @@ func init() { } cmd.Flags().StringVar(&target, "target", "", "") cmd.Flags().StringVar(&endpointId, "endpoint-id", "", "") + cmd.Flags().StringVar(&singleNumberReachPhoneNumber, "single-number-reach-phone-number", "", "") cmd.Flags().StringVar(&lineOwnerId, "line-owner-id", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") diff --git a/cmd/calling/hunt_group.go b/cmd/calling/hunt_group.go index f1b77e2..e9a60d4 100644 --- a/cmd/calling/hunt_group.go +++ b/cmd/calling/hunt_group.go @@ -75,7 +75,7 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create a Hunt Group", - Long: "Create new Hunt Groups for the given location.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nCreating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Create new Hunt Groups for the given location.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nCreating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/huntGroups") req.PathParam("locationId", locationId) @@ -137,7 +137,7 @@ func init() { cmd := &cobra.Command{ Use: "get", Short: "Get Details for a Hunt Group", - Long: "Retrieve Hunt Group details.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve Hunt Group details.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}") req.PathParam("locationId", locationId) @@ -174,7 +174,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Hunt Group", - Long: "Update the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nUpdating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Update the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nUpdating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}") req.PathParam("locationId", locationId) @@ -569,7 +569,7 @@ func init() { cmd := &cobra.Command{ Use: "switch-mode-call-forward", Short: "Switch Mode for Call Forwarding Settings for a Hunt Group", - Long: "Switches the current operating mode of the `Hunt Group` to the mode as per normal operations.\n\nSwitching operating mode for a `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + Long: "Switches the current operating mode of the `Hunt Group` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/callForwarding/actions/switchMode/invoke") req.PathParam("locationId", locationId) diff --git a/cmd/calling/location_call.go b/cmd/calling/location_call.go index fe2b16a..3f88400 100644 --- a/cmd/calling/location_call.go +++ b/cmd/calling/location_call.go @@ -4,6 +4,7 @@ package calling import ( "fmt" + "strconv" "strings" cmd "github.com/Cloverhound/webex-cli/cmd" @@ -17,6 +18,7 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print +var _ = strconv.Itoa var _ = strings.Join var locationCallCmd = &cobra.Command{ @@ -380,6 +382,7 @@ Searching and viewing locations in your organization requires an administrator a var orgId string var selected string var locationMemberId string + var elinExpiryTimeMinutes int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -399,6 +402,7 @@ Searching and viewing locations in your organization requires an administrator a } else { req.BodyString("selected", selected) req.BodyString("locationMemberId", locationMemberId) + req.BodyInt("elinExpiryTimeMinutes", elinExpiryTimeMinutes, cmd.Flags().Changed("elin-expiry-time-minutes")) } resp, statusCode, err := req.Do() if err != nil { @@ -412,6 +416,7 @@ Searching and viewing locations in your organization requires an administrator a cmd.Flags().StringVar(&orgId, "org-id", "", "Update location attributes for this organization.") cmd.Flags().StringVar(&selected, "selected", "", "") cmd.Flags().StringVar(&locationMemberId, "location-member-id", "", "") + cmd.Flags().Int64Var(&elinExpiryTimeMinutes, "elin-expiry-time-minutes", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") locationCallCmd.AddCommand(cmd) diff --git a/cmd/calling/location_voicemail.go b/cmd/calling/location_voicemail.go index 62c24a0..344e731 100644 --- a/cmd/calling/location_voicemail.go +++ b/cmd/calling/location_voicemail.go @@ -103,7 +103,7 @@ func init() { cmd := &cobra.Command{ Use: "get-voiceportal", Short: "Get VoicePortal", - Long: "Retrieve Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant announcements.\n\nRetrieving voice portal information for an organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant announcements.\n\nRetrieving voice portal information for an organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/voicePortal") req.PathParam("locationId", locationId) @@ -136,7 +136,7 @@ func init() { cmd := &cobra.Command{ Use: "update-voiceportal", Short: "Update VoicePortal", - Long: "Update Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant anouncements.\n\nUpdating voice portal information for an organization and/or rules requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Update Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant anouncements.\n\nUpdating voice portal information for an organization and/or rules requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/voicePortal") req.PathParam("locationId", locationId) @@ -243,7 +243,7 @@ func init() { cmd := &cobra.Command{ Use: "get-group", Short: "Get Location Voicemail Group", - Long: "Retrieve voicemail group details for a location.\n\nManage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nRetrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve voicemail group details for a location.\n\nManage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nRetrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/voicemailGroups/{voicemailGroupId}") req.PathParam("locationId", locationId) @@ -280,7 +280,7 @@ func init() { cmd := &cobra.Command{ Use: "update-group", Short: "Modify Location Voicemail Group", - Long: "Modifies the voicemail group location details for a particular location for a customer.\n\nManage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nModifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Modifies the voicemail group location details for a particular location for a customer.\n\nManage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nModifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/voicemailGroups/{voicemailGroupId}") req.PathParam("locationId", locationId) @@ -346,7 +346,7 @@ func init() { cmd := &cobra.Command{ Use: "create-group", Short: "Create a new Voicemail Group for a Location", - Long: "Create a new voicemail group for the given location for a customer.\n\nA voicemail group can be created for given location for a customer.\n\nCreating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Create a new voicemail group for the given location for a customer.\n\nA voicemail group can be created for given location for a customer.\n\nCreating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/voicemailGroups") req.PathParam("locationId", locationId) diff --git a/cmd/calling/paging_group.go b/cmd/calling/paging_group.go index c5daf31..d0a5fc9 100644 --- a/cmd/calling/paging_group.go +++ b/cmd/calling/paging_group.go @@ -77,7 +77,7 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create a new Paging Group", - Long: "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/telephony/config/locations/{locationId}/paging") req.PathParam("locationId", locationId) @@ -139,7 +139,7 @@ func init() { cmd := &cobra.Command{ Use: "get", Short: "Get Details for a Paging Group", - Long: "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/locations/{locationId}/paging/{pagingId}") req.PathParam("locationId", locationId) @@ -176,7 +176,7 @@ func init() { cmd := &cobra.Command{ Use: "update", Short: "Update a Paging Group", - Long: "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/locations/{locationId}/paging/{pagingId}") req.PathParam("locationId", locationId) diff --git a/cmd/calling/people.go b/cmd/calling/people.go index 54de020..ab518ea 100644 --- a/cmd/calling/people.go +++ b/cmd/calling/people.go @@ -40,7 +40,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List People", - Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/people") req.QueryParam("email", email) diff --git a/cmd/calling/user_call.go b/cmd/calling/user_call.go index 3f432c0..7c131b9 100644 --- a/cmd/calling/user_call.go +++ b/cmd/calling/user_call.go @@ -468,7 +468,7 @@ This API requires a full or user administrator or location administrator auth to cmd := &cobra.Command{ Use: "get-caller-id-person", Short: "Read Caller ID Settings for a Person", - Long: "Retrieve a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/people/{personId}/features/callerId") req.PathParam("personId", personId) @@ -501,7 +501,7 @@ This API requires a full or user administrator or location administrator auth to cmd := &cobra.Command{ Use: "update-caller-id-person", Short: "Configure Caller ID Settings for a Person", - Long: "Configure a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Configure a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/people/{personId}/features/callerId") req.PathParam("personId", personId) @@ -5221,4 +5221,108 @@ This API requires a full or user administrator or location administrator auth to userCallCmd.AddCommand(cmd) } + { // get-timezone-announcement-language-settings-person + var personId string + var orgId string + cmd := &cobra.Command{ + Use: "get-timezone-announcement-language-settings-person", + Short: "Get Timezone and Announcement Language Settings of a Person", + Long: "Retrieve a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/people/{personId}") + req.PathParam("personId", personId) + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&personId, "person-id", "", "Retrieve timezone and announcement language settings of this person.") + cmd.MarkFlagRequired("person-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Organization ID. If not specified, uses the organization from the OAuth token.") + userCallCmd.AddCommand(cmd) + } + + { // update-timezone-announcement-language-settings-person + var personId string + var orgId string + var announcementLanguage string + var timeZone string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-timezone-announcement-language-settings-person", + Short: "Update Timezone and Announcement Language Settings of a Person", + Long: "Modify a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/people/{personId}") + req.PathParam("personId", personId) + req.QueryParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("announcementLanguage", announcementLanguage) + req.BodyString("timeZone", timeZone) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&personId, "person-id", "", "Modify timezone and announcement language settings of this person.") + cmd.MarkFlagRequired("person-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Organization ID. If not specified, uses the organization from the OAuth token.") + cmd.Flags().StringVar(&announcementLanguage, "announcement-language", "", "") + cmd.Flags().StringVar(&timeZone, "time-zone", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + userCallCmd.AddCommand(cmd) + } + + { // get-country-calling-configuration + var countryCode string + var orgId string + cmd := &cobra.Command{ + Use: "get-country-calling-configuration", + Short: "Get Country Calling Configuration", + Long: "Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones.\n\nThis information helps administrators configure user settings with valid timezone and location data for a specific country.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/countries/{countryCode}") + req.PathParam("countryCode", countryCode) + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&countryCode, "country-code", "", "The ISO country code to retrieve configuration for.") + cmd.MarkFlagRequired("country-code") + cmd.Flags().StringVar(&orgId, "org-id", "", "Organization ID. If not specified, uses the organization from the OAuth token.") + userCallCmd.AddCommand(cmd) + } + } diff --git a/cmd/calling/virtual_line_call.go b/cmd/calling/virtual_line_call.go index 1d45eee..8da9c9a 100644 --- a/cmd/calling/virtual_line_call.go +++ b/cmd/calling/virtual_line_call.go @@ -477,7 +477,7 @@ func init() { cmd := &cobra.Command{ Use: "get-caller-id", Short: "Read Caller ID Settings for a Virtual Line", - Long: "Retrieve a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nRetrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nRetrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/telephony/config/virtualLines/{virtualLineId}/callerId") req.PathParam("virtualLineId", virtualLineId) @@ -510,7 +510,7 @@ func init() { cmd := &cobra.Command{ Use: "update-caller-id", Short: "Configure Caller ID Settings for a Virtual Line", - Long: "Configure a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nUpdating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Configure a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nUpdating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/telephony/config/virtualLines/{virtualLineId}/callerId") req.PathParam("virtualLineId", virtualLineId) diff --git a/cmd/calling/workspace_call.go b/cmd/calling/workspace_call.go index 39d4dd7..24aeb2e 100644 --- a/cmd/calling/workspace_call.go +++ b/cmd/calling/workspace_call.go @@ -171,7 +171,7 @@ func init() { cmd := &cobra.Command{ Use: "get-caller-id", Short: "Read Caller ID Settings for a Workspace", - Long: "Retrieve a workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `displayName` and `displayDetail` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Retrieve a workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/workspaces/{workspaceId}/features/callerId") req.PathParam("workspaceId", workspaceId) @@ -204,7 +204,7 @@ func init() { cmd := &cobra.Command{ Use: "update-caller-id", Short: "Configure Caller ID Settings for a Workspace", - Long: "Configure workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `displayName` and `displayDetail` fields to configure and view both caller ID and dial-by-name settings.
", + Long: "Configure workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "PUT", "/workspaces/{workspaceId}/features/callerId") req.PathParam("workspaceId", workspaceId) diff --git a/cmd/cc/agent_summaries.go b/cmd/cc/agent_summaries.go index b2f7826..3b2f15f 100644 --- a/cmd/cc/agent_summaries.go +++ b/cmd/cc/agent_summaries.go @@ -65,7 +65,7 @@ func init() { { // list-2 var orgId string - var interactionId string + var agentCiUserId string var searchType string var bodyRaw string var bodyFile string @@ -83,7 +83,7 @@ func init() { req.SetBodyRaw(bodyRaw) } else { req.BodyString("orgId", orgId) - req.BodyString("interactionId", interactionId) + req.BodyString("agentCiUserId", agentCiUserId) req.BodyString("searchType", searchType) } resp, statusCode, err := req.Do() @@ -94,7 +94,7 @@ func init() { }, } cmd.Flags().StringVar(&orgId, "org-id", "", "") - cmd.Flags().StringVar(&interactionId, "interaction-id", "", "") + cmd.Flags().StringVar(&agentCiUserId, "agent-ci-user-id", "", "") cmd.Flags().StringVar(&searchType, "search-type", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") diff --git a/cmd/cc/agent_wellbeing.go b/cmd/cc/agent_wellbeing.go index 93a3ba0..96a7252 100644 --- a/cmd/cc/agent_wellbeing.go +++ b/cmd/cc/agent_wellbeing.go @@ -116,7 +116,7 @@ func init() { cmd := &cobra.Command{ Use: "get-burnout-id", Short: "Get specific Agent Burnout resource by ID", - Long: `Retrieve an existing Agent Burnout resource by ID in a given organization.`, + Long: `Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/agent-burnout/{id}") req.PathParam("orgid", orgid) @@ -150,12 +150,14 @@ func init() { var organizationId string var version int64 var wellnessBreakReminders string + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "update-burnout-id", Short: "Update specific Agent Burnout resource by ID", - Long: `Update an existing Agent Burnout resource by ID in a given organization.`, + Long: `Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/agent-burnout/{id}") req.PathParam("orgid", orgid) @@ -173,6 +175,8 @@ func init() { req.BodyString("id", id) req.BodyInt("version", version, cmd.Flags().Changed("version")) req.BodyString("wellnessBreakReminders", wellnessBreakReminders) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -190,6 +194,8 @@ func init() { cmd.Flags().StringVar(&organizationId, "organization-id", "", "") cmd.Flags().Int64Var(&version, "version", 0, "") cmd.Flags().StringVar(&wellnessBreakReminders, "wellness-break-reminders", "", "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") agentWellbeingCmd.AddCommand(cmd) @@ -204,7 +210,7 @@ func init() { cmd := &cobra.Command{ Use: "list-burnout", Short: "List Agent Burnout resource(s)", - Long: `Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource.`, + Long: `Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource. Deprecated. Use GET /v2/ai-feature/agent-burnout instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/agent-burnout") req.PathParam("orgid", orgid) @@ -228,8 +234,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") agentWellbeingCmd.AddCommand(cmd) diff --git a/cmd/cc/ai_feature.go b/cmd/cc/ai_feature.go index f043210..c44df26 100644 --- a/cmd/cc/ai_feature.go +++ b/cmd/cc/ai_feature.go @@ -110,6 +110,188 @@ func init() { req.PathParam("orgid", orgid) req.QueryParam("filter", filter) req.QueryParam("attributes", attributes) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. Supported filterable fields: id. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") + aiFeatureCmd.AddCommand(cmd) + } + + { // create-question-mapped-autocsat + var orgid string + var questionId string + var questionnaireId string + var organizationId string + var id string + var version int64 + var createdTime int64 + var lastUpdatedTime int64 + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create-question-mapped-autocsat", + Short: "Create a new Question mapped to AutoCSAT", + Long: `Create a new Auto CSAT mapped Question in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/ai-feature/auto-csat/question") + req.PathParam("orgid", orgid) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("questionId", questionId) + req.BodyString("questionnaireId", questionnaireId) + req.BodyString("organizationId", organizationId) + req.BodyString("id", id) + req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&questionId, "question-id", "", "") + cmd.Flags().StringVar(&questionnaireId, "questionnaire-id", "", "") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + aiFeatureCmd.AddCommand(cmd) + } + + { // bulk-save-question-mapped-autocsat + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "bulk-save-question-mapped-autocsat", + Short: "Bulk save Question mapped to AutoCSAT", + Long: `Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/ai-feature/auto-csat/question/bulk") + req.PathParam("orgid", orgid) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + aiFeatureCmd.AddCommand(cmd) + } + + { // get-question-mapped-autocsat-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "get-question-mapped-autocsat-id", + Short: "Get specific Question mapped to AutoCSAT by ID", + Long: `Retrieve an existing Auto CSAT mapped Question by ID in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/ai-feature/auto-csat/question/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Auto CSAT mapped Question.") + cmd.MarkFlagRequired("id") + aiFeatureCmd.AddCommand(cmd) + } + + { // delete-question-mapped-autocsat-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "delete-question-mapped-autocsat-id", + Short: "Delete specific Question mapped to AutoCSAT by ID", + Long: `Delete an existing Auto CSAT mapped Question by ID in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/ai-feature/auto-csat/question/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Auto CSAT mapped Question.") + cmd.MarkFlagRequired("id") + aiFeatureCmd.AddCommand(cmd) + } + + { // list-question-mapped-autocsat + var orgid string + var filter string + var attributes string + var page string + var pageSize string + cmd := &cobra.Command{ + Use: "list-question-mapped-autocsat", + Short: "List Question mapped to AutoCSAT(s)", + Long: `Retrieve a list of Auto CSAT mapped Question(s) in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/ai-feature/auto-csat/question") + req.PathParam("orgid", orgid) + req.QueryParam("filter", filter) req.QueryParam("attributes", attributes) req.QueryParam("page", page) req.QueryParam("pageSize", pageSize) @@ -129,8 +311,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. Supported filterable fields: id. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") aiFeatureCmd.AddCommand(cmd) diff --git a/cmd/cc/auto_csat.go b/cmd/cc/auto_csat.go index 7dc7a4f..95aa53e 100644 --- a/cmd/cc/auto_csat.go +++ b/cmd/cc/auto_csat.go @@ -35,12 +35,14 @@ func init() { var organizationId string var id string var version int64 + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "create-mapped-question", Short: "Create a new Auto CSAT mapped Question", - Long: `Create a new Auto CSAT mapped Question in a given organization.`, + Long: `Create a new Auto CSAT mapped Question in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/auto-csat/{autoCsatId}/question") req.PathParam("orgid", orgid) @@ -57,6 +59,8 @@ func init() { req.BodyString("organizationId", organizationId) req.BodyString("id", id) req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -74,6 +78,8 @@ func init() { cmd.Flags().StringVar(&organizationId, "organization-id", "", "") cmd.Flags().StringVar(&id, "id", "", "") cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") autoCsatCmd.AddCommand(cmd) @@ -87,7 +93,7 @@ func init() { cmd := &cobra.Command{ Use: "bulk-save-mapped-question", Short: "Bulk save Auto CSAT mapped Question(s)", - Long: `Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization.`, + Long: `Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question/bulk instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/auto-csat/{autoCsatId}/question/bulk") req.PathParam("orgid", orgid) @@ -122,7 +128,7 @@ func init() { cmd := &cobra.Command{ Use: "get-mapped-question-id", Short: "Get specific Auto CSAT mapped Question by ID", - Long: `Retrieve an existing Auto CSAT mapped Question by ID in a given organization.`, + Long: `Retrieve an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/question/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/auto-csat/{autoCsatId}/question/{id}") req.PathParam("orgid", orgid) @@ -158,7 +164,7 @@ func init() { cmd := &cobra.Command{ Use: "delete-mapped-question-id", Short: "Delete specific Auto CSAT mapped Question by ID", - Long: `Delete an existing Auto CSAT mapped Question by ID in a given organization.`, + Long: `Delete an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use DELETE /ai-feature/auto-csat/question/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/organization/{orgid}/auto-csat/{autoCsatId}/question/{id}") req.PathParam("orgid", orgid) @@ -186,7 +192,7 @@ func init() { cmd := &cobra.Command{ Use: "get-id", Short: "Get specific Auto CSAT resource by ID", - Long: `Retrieve an existing Auto CSAT resource by ID in a given organization.`, + Long: `Retrieve an existing Auto CSAT resource by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/auto-csat/{id}") req.PathParam("orgid", orgid) @@ -221,12 +227,14 @@ func init() { var surveyDataSource string var organizationId string var version int64 + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "update-id", Short: "Update specific Auto CSAT resource by ID", - Long: `Update an existing Auto CSAT resource by ID in a given organization.`, + Long: `Update an existing Auto CSAT resource by ID in a given organization. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/auto-csat/{id}") req.PathParam("orgid", orgid) @@ -245,6 +253,8 @@ func init() { req.BodyString("organizationId", organizationId) req.BodyString("id", id) req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -263,6 +273,8 @@ func init() { cmd.Flags().StringVar(&surveyDataSource, "survey-data-source", "", "") cmd.Flags().StringVar(&organizationId, "organization-id", "", "") cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") autoCsatCmd.AddCommand(cmd) @@ -277,7 +289,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List Auto CSAT resource(s)", - Long: `Retrieve a list of Auto CSAT resource(s) in a given organization.Only one entry per organization can exist for Auto CSAT resource.`, + Long: `Retrieve a list of Auto CSAT resource(s) in a given organization.Only one entry per organization can exist for Auto CSAT resource. Deprecated. Use GET /v2/ai-feature/auto-csat instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/auto-csat") req.PathParam("orgid", orgid) @@ -301,8 +313,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") autoCsatCmd.AddCommand(cmd) @@ -318,7 +330,7 @@ func init() { cmd := &cobra.Command{ Use: "list-mapped-question", Short: "List Auto CSAT mapped Question(s)", - Long: `Retrieve a list of Auto CSAT mapped Question(s) in a given organization.`, + Long: `Retrieve a list of Auto CSAT mapped Question(s) in a given organization. Deprecated. Use GET /v2/ai-feature/auto-csat/question instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/auto-csat/{autoCsatId}/question") req.PathParam("orgid", orgid) @@ -345,8 +357,8 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&autoCsatId, "auto-csat-id", "", "Resource ID of the Auto CSAT resource") cmd.MarkFlagRequired("auto-csat-id") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") autoCsatCmd.AddCommand(cmd) diff --git a/cmd/cc/business_hour.go b/cmd/cc/business_hour.go index 60e01bf..2678080 100644 --- a/cmd/cc/business_hour.go +++ b/cmd/cc/business_hour.go @@ -69,8 +69,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") diff --git a/cmd/cc/campaign_manager.go b/cmd/cc/campaign_manager.go index 30dd160..3ced42b 100644 --- a/cmd/cc/campaign_manager.go +++ b/cmd/cc/campaign_manager.go @@ -35,7 +35,7 @@ func init() { cmd := &cobra.Command{ Use: "start-request", Short: "Start Campaign Request", - Long: `A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications. This type of API typically allows businesses to set up the parameters for a campaign, such as the list of phone numbers to call, the message or script to deliver, and the time of day or day of the week to call. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization`, + Long: `A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications. This type of API typically allows businesses to set up the parameters for a campaign, such as the list of phone numbers to call, the message or script to deliver, and the time of day or day of the week to call. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/v1/dialer/campaign") if bodyFile != "" { @@ -75,7 +75,7 @@ func init() { cmd := &cobra.Command{ Use: "update-request", Short: "Update Campaign Request", - Long: `By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications. This can help to improve efficiency and reduce errors, as well as allow for greater flexibility and control over outbound campaigns. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization.`, + Long: `By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications. This can help to improve efficiency and reduce errors, as well as allow for greater flexibility and control over outbound campaigns. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/v1/dialer/campaign/{campaignId}") req.PathParam("campaignId", campaignId) @@ -128,7 +128,7 @@ func init() { cmd := &cobra.Command{ Use: "stop-request", Short: "Stop Campaign Request", - Long: `The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization.`, + Long: `The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "DELETE", "/v1/dialer/campaign/{campaignId}") req.PathParam("campaignId", campaignId) diff --git a/cmd/cc/contact_service_queue.go b/cmd/cc/contact_service_queue.go index cd71963..293e429 100644 --- a/cmd/cc/contact_service_queue.go +++ b/cmd/cc/contact_service_queue.go @@ -71,13 +71,13 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name, description) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\",\"description\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") - cmd.Flags().StringVar(&desktopProfileFilter, "desktop-profile-filter", "", "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.") - cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ") + cmd.Flags().StringVar(&desktopProfileFilter, "desktop-profile-filter", "", "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.") cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.") contactServiceQueueCmd.AddCommand(cmd) } @@ -215,13 +215,13 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // get-skill-profile-id + { // list-skill-csqs-skill-profile var orgid string var id string cmd := &cobra.Command{ - Use: "get-skill-profile-id", - Short: "Get specific By skill profile ID", - Long: `Retrieve an existing Contact Service Queue by skill profile ID in a given organization.`, + Use: "list-skill-csqs-skill-profile", + Short: "List Skill CSQs by Skill Profile", + Long: `Retrieve skill-based Contact Service Queues by skill profile ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}") req.PathParam("orgid", orgid) @@ -247,14 +247,14 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // delete-references + { // delete-csq-references var orgid string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "delete-references", - Short: "Delete References", - Long: `Delete References for existing Contact Service Queue in a given organization.`, + Use: "delete-csq-references", + Short: "Delete CSQ References", + Long: `Delete references for Contact Service Queues in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/delete-reference") req.PathParam("orgid", orgid) @@ -272,22 +272,23 @@ func init() { return output.Print(resp, statusCode) }, } - cmd.Flags().StringVar(&orgid, "orgid", "", "") + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") contactServiceQueueCmd.AddCommand(cmd) } - { // get-manually-assignable + { // list-manually-assignable-csqs var orgid string var agentId string var teamId string var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "get-manually-assignable", - Short: "Fetch manually assignable Queues", + Use: "list-manually-assignable-csqs", + Short: "List Manually Assignable CSQs", + Long: `Retrieve manually assignable Contact Service Queues in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues") req.PathParam("orgid", orgid) @@ -347,7 +348,7 @@ func init() { var agentsUpdatedInfo string cmd := &cobra.Command{ Use: "get-id", - Short: "Get specific Contact Service Queue by Id", + Short: "Get specific Contact Service Queue by ID", Long: `Retrieve an existing Contact Service Queue by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/contact-service-queue/{id}") @@ -437,15 +438,15 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } - { // list-references + { // list-csq-references-id var orgid string var id string var typeVal string var page string var pageSize string cmd := &cobra.Command{ - Use: "list-references", - Short: "List references for a specific Contact Service Queue", + Use: "list-csq-references-id", + Short: "List CSQ References by ID", Long: `Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/{id}/incoming-references") @@ -487,7 +488,7 @@ func init() { cmd := &cobra.Command{ Use: "list-agent-based", Short: "List agent based Contact Service Queue(s)by user ID", - Long: `Retrieve a list of agent based Contact Service Queue(s) by user id in a given organization.`, + Long: `Retrieve a list of agent based Contact Service Queue(s) by user iD in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/agent-based-queues") req.PathParam("orgid", orgid) @@ -528,7 +529,7 @@ func init() { cmd := &cobra.Command{ Use: "list-skill-based", Short: "List skill based Contact Service Queue(s)by user ID", - Long: `Retrieve a list of skill based Contact Service Queue(s) by user id in a given organization.`, + Long: `Retrieve a list of skill based Contact Service Queue(s) by user ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/skill-based-queues") req.PathParam("orgid", orgid) @@ -568,8 +569,8 @@ func init() { var pageSize string cmd := &cobra.Command{ Use: "list-team-based", - Short: "List Team based Contact Service Queue(s)by user id", - Long: `Retrieve a list of team based Contact Service Queue(s) by user id in a given organization.`, + Short: "List team based Contact Service Queue(s)by user ID", + Long: `Retrieve a list of team based Contact Service Queue(s) by user ID in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/team-based-queues") req.PathParam("orgid", orgid) @@ -644,4 +645,238 @@ func init() { contactServiceQueueCmd.AddCommand(cmd) } + { // list-mapping-summary-grouped-assistant-skill + var orgid string + var page string + var pageSize string + var assistantSkillIds []string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "list-mapping-summary-grouped-assistant-skill", + Short: "List queue mapping summary grouped by Assistant Skill", + Long: `Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/v2/contact-service-queue/fetch-by-grouped-assistant-skill") + req.PathParam("orgid", orgid) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyStringSlice("assistantSkillIds", assistantSkillIds) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") + cmd.Flags().StringSliceVar(&assistantSkillIds, "assistant-skill-ids", nil, "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-internal-skill-csqs-profile + var orgid string + var id string + cmd := &cobra.Command{ + Use: "list-internal-skill-csqs-profile", + Short: "List Internal Skill CSQs by Profile", + Long: `Retrieve skill-based Contact Service Queues by skill profile ID for internal use in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}/internal") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "ID of this contact center resource.") + cmd.MarkFlagRequired("id") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-team-csqs-team-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "list-team-csqs-team-id", + Short: "List Team CSQs by Team ID", + Long: `Retrieve team-based Contact Service Queues by team ID for internal use in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/by-team-id/{id}/internal") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "ID of this contact center resource.") + cmd.MarkFlagRequired("id") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-agent-csqs-ci-user-id + var orgid string + var ciUserId string + cmd := &cobra.Command{ + Use: "list-agent-csqs-ci-user-id", + Short: "List Agent CSQs by CI User ID", + Long: `Retrieve agent-based Contact Service Queues by CI user ID for internal use in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/by-user-ci-id/{ciUserId}/internal") + req.PathParam("orgid", orgid) + req.PathParam("ciUserId", ciUserId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&ciUserId, "ci-user-id", "", "ciUserId") + cmd.MarkFlagRequired("ci-user-id") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-csqs-skills-profile + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "list-csqs-skills-profile", + Short: "List CSQs by Skills and Profile", + Long: `Retrieve skill-based Contact Service Queues by dynamic skills and skill profile in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile") + req.PathParam("orgid", orgid) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-csqs-user-profile + var orgid string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "list-csqs-user-profile", + Short: "List CSQs by User and Profile", + Long: `Retrieve skill-based Contact Service Queues by user ID and skill profile ID in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId") + req.PathParam("orgid", orgid) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + contactServiceQueueCmd.AddCommand(cmd) + } + + { // list-skill-csqs-ci-user-id + var orgid string + var id string + cmd := &cobra.Command{ + Use: "list-skill-csqs-ci-user-id", + Short: "List Skill CSQs by CI User ID", + Long: `Retrieve skill-based Contact Service Queues by CI user ID for internal use in a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/contact-service-queue/skill-based-queues/by-ci-user-id/{id}/internal") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "ID of this contact center resource.") + cmd.MarkFlagRequired("id") + contactServiceQueueCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/desktop_layout.go b/cmd/cc/desktop_layout.go index 6a14630..0825aaa 100644 --- a/cmd/cc/desktop_layout.go +++ b/cmd/cc/desktop_layout.go @@ -48,6 +48,8 @@ func init() { var modifiedTime int64 var teamIds []string var systemDefault bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -81,6 +83,8 @@ func init() { req.BodyInt("modifiedTime", modifiedTime, cmd.Flags().Changed("modified-time")) req.BodyStringSlice("teamIds", teamIds) req.BodyBool("systemDefault", systemDefault, cmd.Flags().Changed("system-default")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -108,6 +112,8 @@ func init() { cmd.Flags().Int64Var(&modifiedTime, "modified-time", 0, "") cmd.Flags().StringSliceVar(&teamIds, "team-ids", nil, "") cmd.Flags().BoolVar(&systemDefault, "system-default", false, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") desktopLayoutCmd.AddCommand(cmd) @@ -254,6 +260,8 @@ func init() { var modifiedTime int64 var teamIds []string var systemDefault bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -288,6 +296,8 @@ func init() { req.BodyInt("modifiedTime", modifiedTime, cmd.Flags().Changed("modified-time")) req.BodyStringSlice("teamIds", teamIds) req.BodyBool("systemDefault", systemDefault, cmd.Flags().Changed("system-default")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -316,6 +326,8 @@ func init() { cmd.Flags().Int64Var(&modifiedTime, "modified-time", 0, "") cmd.Flags().StringSliceVar(&teamIds, "team-ids", nil, "") cmd.Flags().BoolVar(&systemDefault, "system-default", false, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") desktopLayoutCmd.AddCommand(cmd) @@ -395,6 +407,7 @@ func init() { var page string var pageSize string var singleObjectResponse string + var provisioningView string cmd := &cobra.Command{ Use: "list", Short: "List Desktop Layout(s)", @@ -409,6 +422,7 @@ func init() { req.QueryParam("page", page) req.QueryParam("pageSize", pageSize) req.QueryParam("singleObjectResponse", singleObjectResponse) + req.QueryParam("provisioningView", provisioningView) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -425,12 +439,13 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that user has access to, according to User Profile.") desktopLayoutCmd.AddCommand(cmd) } diff --git a/cmd/cc/generated_summaries.go b/cmd/cc/generated_summaries.go index feca8f7..566422e 100644 --- a/cmd/cc/generated_summaries.go +++ b/cmd/cc/generated_summaries.go @@ -33,7 +33,7 @@ func init() { cmd := &cobra.Command{ Use: "get-id", Short: "Get specific Generated Summaries resource by ID", - Long: `Retrieve an existing Generated Summaries resource by ID in a given organization.`, + Long: `Retrieve an existing Generated Summaries resource by ID in a given organization. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/generated-summaries/{id}") req.PathParam("orgid", orgid) @@ -68,12 +68,14 @@ func init() { var virtualAgentTransferSummariesEnabled bool var consultTransferSummariesEnabled bool var agentInclusionType string + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ Use: "update-id", Short: "Update specific Generated Summaries resource by ID", - Long: `Update an existing Generated Summaries resource by ID in a given organization.`, + Long: `Update an existing Generated Summaries resource by ID in a given organization. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/generated-summaries/{id}") req.PathParam("orgid", orgid) @@ -92,6 +94,8 @@ func init() { req.BodyBool("virtualAgentTransferSummariesEnabled", virtualAgentTransferSummariesEnabled, cmd.Flags().Changed("virtual-agent-transfer-summaries-enabled")) req.BodyBool("consultTransferSummariesEnabled", consultTransferSummariesEnabled, cmd.Flags().Changed("consult-transfer-summaries-enabled")) req.BodyString("agentInclusionType", agentInclusionType) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -110,6 +114,8 @@ func init() { cmd.Flags().BoolVar(&virtualAgentTransferSummariesEnabled, "virtual-agent-transfer-summaries-enabled", false, "") cmd.Flags().BoolVar(&consultTransferSummariesEnabled, "consult-transfer-summaries-enabled", false, "") cmd.Flags().StringVar(&agentInclusionType, "agent-inclusion-type", "", "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") generatedSummariesCmd.AddCommand(cmd) @@ -124,7 +130,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List Generated Summaries resource(s)", - Long: `Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries resource.`, + Long: `Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries resource. Deprecated. Use GET /v2/ai-feature/generated-summaries instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/generated-summaries") req.PathParam("orgid", orgid) @@ -148,8 +154,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") generatedSummariesCmd.AddCommand(cmd) diff --git a/cmd/cc/holiday_list.go b/cmd/cc/holiday_list.go index b450bbf..a9991c2 100644 --- a/cmd/cc/holiday_list.go +++ b/cmd/cc/holiday_list.go @@ -69,8 +69,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") diff --git a/cmd/cc/outdial_ani.go b/cmd/cc/outdial_ani.go index c2887e6..3ad174c 100644 --- a/cmd/cc/outdial_ani.go +++ b/cmd/cc/outdial_ani.go @@ -65,8 +65,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name, description) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\",\"description\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") @@ -207,8 +207,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. Supported filterable fields: id. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. Supported filterable fields: id. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") @@ -357,6 +357,9 @@ func init() { var organizationId string var id string var version int64 + var defaultAnientry bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -379,6 +382,9 @@ func init() { req.BodyString("organizationId", organizationId) req.BodyString("id", id) req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyBool("defaultANIEntry", defaultAnientry, cmd.Flags().Changed("default-anientry")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -396,6 +402,9 @@ func init() { cmd.Flags().StringVar(&organizationId, "organization-id", "", "") cmd.Flags().StringVar(&id, "id", "", "") cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().BoolVar(&defaultAnientry, "default-anientry", false, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") outdialAniCmd.AddCommand(cmd) @@ -481,6 +490,9 @@ func init() { var number string var organizationId string var version int64 + var defaultAnientry bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -504,6 +516,9 @@ func init() { req.BodyString("organizationId", organizationId) req.BodyString("id", id) req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyBool("defaultANIEntry", defaultAnientry, cmd.Flags().Changed("default-anientry")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -522,6 +537,9 @@ func init() { cmd.Flags().StringVar(&number, "number", "", "") cmd.Flags().StringVar(&organizationId, "organization-id", "", "") cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().BoolVar(&defaultAnientry, "default-anientry", false, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") outdialAniCmd.AddCommand(cmd) @@ -595,8 +613,8 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&outDialAniId, "out-dial-ani-id", "", "Resource ID of the Outdial ANI") cmd.MarkFlagRequired("out-dial-ani-id") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") diff --git a/cmd/cc/overrides.go b/cmd/cc/overrides.go index 4560a1b..88b2994 100644 --- a/cmd/cc/overrides.go +++ b/cmd/cc/overrides.go @@ -69,8 +69,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") diff --git a/cmd/cc/skill.go b/cmd/cc/skill.go index 04ef9c5..b1873f7 100644 --- a/cmd/cc/skill.go +++ b/cmd/cc/skill.go @@ -39,7 +39,7 @@ func init() { Use: "list", Short: "List Skill(s)", Long: `Retrieve a list of Skill(s) in a given organization. - Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.`, + Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/skill") req.PathParam("orgid", orgid) @@ -65,8 +65,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") @@ -76,6 +76,18 @@ func init() { { // create var orgid string + var active string + var name string + var serviceLevelThreshold string + var skillType string + var organizationId string + var id string + var version string + var description string + var enumSkillValues string + var dynamicSkill string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -85,6 +97,18 @@ func init() { RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/skill") req.PathParam("orgid", orgid) + req.QueryParam("active", active) + req.QueryParam("name", name) + req.QueryParam("serviceLevelThreshold", serviceLevelThreshold) + req.QueryParam("skillType", skillType) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("enumSkillValues", enumSkillValues) + req.QueryParam("dynamicSkill", dynamicSkill) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -101,6 +125,18 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&active, "active", "", "Skill configuration data") + cmd.Flags().StringVar(&name, "name", "", "Skill configuration data") + cmd.Flags().StringVar(&serviceLevelThreshold, "service-level-threshold", "", "Skill configuration data") + cmd.Flags().StringVar(&skillType, "skill-type", "", "Skill configuration data") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Skill configuration data") + cmd.Flags().StringVar(&id, "id", "", "Skill configuration data") + cmd.Flags().StringVar(&version, "version", "", "Skill configuration data") + cmd.Flags().StringVar(&description, "description", "", "Skill configuration data") + cmd.Flags().StringVar(&enumSkillValues, "enum-skill-values", "", "Skill configuration data") + cmd.Flags().StringVar(&dynamicSkill, "dynamic-skill", "", "Skill configuration data") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Skill configuration data") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Skill configuration data") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") skillCmd.AddCommand(cmd) @@ -231,6 +267,17 @@ func init() { { // update-id var orgid string var id string + var active string + var name string + var serviceLevelThreshold string + var skillType string + var organizationId string + var version string + var description string + var enumSkillValues string + var dynamicSkill string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -241,6 +288,18 @@ func init() { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/skill/{id}") req.PathParam("orgid", orgid) req.PathParam("id", id) + req.QueryParam("active", active) + req.QueryParam("name", name) + req.QueryParam("serviceLevelThreshold", serviceLevelThreshold) + req.QueryParam("skillType", skillType) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("enumSkillValues", enumSkillValues) + req.QueryParam("dynamicSkill", dynamicSkill) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -259,6 +318,17 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Skill.") cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&active, "active", "", "Skill configuration data for update") + cmd.Flags().StringVar(&name, "name", "", "Skill configuration data for update") + cmd.Flags().StringVar(&serviceLevelThreshold, "service-level-threshold", "", "Skill configuration data for update") + cmd.Flags().StringVar(&skillType, "skill-type", "", "Skill configuration data for update") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Skill configuration data for update") + cmd.Flags().StringVar(&version, "version", "", "Skill configuration data for update") + cmd.Flags().StringVar(&description, "description", "", "Skill configuration data for update") + cmd.Flags().StringVar(&enumSkillValues, "enum-skill-values", "", "Skill configuration data for update") + cmd.Flags().StringVar(&dynamicSkill, "dynamic-skill", "", "Skill configuration data for update") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Skill configuration data for update") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Skill configuration data for update") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") skillCmd.AddCommand(cmd) @@ -330,4 +400,28 @@ func init() { skillCmd.AddCommand(cmd) } + { // populate-json-attributes-field-skill-id-org + var orgid string + var id string + cmd := &cobra.Command{ + Use: "populate-json-attributes-field-skill-id-org", + Short: "Populate json-attributes field for a given skill-id of an organization", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/skill/populate-json-attr/{id}") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.MarkFlagRequired("id") + skillCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/skill_profile.go b/cmd/cc/skill_profile.go index beaab34..86d0693 100644 --- a/cmd/cc/skill_profile.go +++ b/cmd/cc/skill_profile.go @@ -39,7 +39,7 @@ func init() { Use: "list", Short: "List Skill Profile(s)", Long: `Retrieve a list of Skill Profile(s) in a given organization. - Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.`, + Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/v2/skill-profile") req.PathParam("orgid", orgid) @@ -65,8 +65,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name, description) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\",\"description\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") @@ -76,6 +76,15 @@ func init() { { // create var orgid string + var activeSkills string + var name string + var organizationId string + var id string + var version string + var description string + var activeEnumSkills string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -85,6 +94,15 @@ func init() { RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/skill-profile") req.PathParam("orgid", orgid) + req.QueryParam("activeSkills", activeSkills) + req.QueryParam("name", name) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("activeEnumSkills", activeEnumSkills) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -101,6 +119,15 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&activeSkills, "active-skills", "", "Skill profile configuration data") + cmd.Flags().StringVar(&name, "name", "", "Skill profile configuration data") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Skill profile configuration data") + cmd.Flags().StringVar(&id, "id", "", "Skill profile configuration data") + cmd.Flags().StringVar(&version, "version", "", "Skill profile configuration data") + cmd.Flags().StringVar(&description, "description", "", "Skill profile configuration data") + cmd.Flags().StringVar(&activeEnumSkills, "active-enum-skills", "", "Skill profile configuration data") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Skill profile configuration data") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Skill profile configuration data") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") skillProfileCmd.AddCommand(cmd) @@ -210,6 +237,14 @@ func init() { { // update-id var orgid string var id string + var activeSkills string + var name string + var organizationId string + var version string + var description string + var activeEnumSkills string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -220,6 +255,15 @@ func init() { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/skill-profile/{id}") req.PathParam("orgid", orgid) req.PathParam("id", id) + req.QueryParam("activeSkills", activeSkills) + req.QueryParam("name", name) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("description", description) + req.QueryParam("activeEnumSkills", activeEnumSkills) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -238,6 +282,14 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Skill Profile.") cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&activeSkills, "active-skills", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&name, "name", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&version, "version", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&description, "description", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&activeEnumSkills, "active-enum-skills", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&createdTime, "created-time", "", "Skill profile configuration data for update") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "Skill profile configuration data for update") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") skillProfileCmd.AddCommand(cmd) diff --git a/cmd/cc/tasks.go b/cmd/cc/tasks.go index c401a90..cd09714 100644 --- a/cmd/cc/tasks.go +++ b/cmd/cc/tasks.go @@ -4,6 +4,7 @@ package cc import ( "fmt" + "strconv" cmd "github.com/Cloverhound/webex-cli/cmd" "github.com/Cloverhound/webex-cli/internal/client" @@ -17,6 +18,7 @@ import ( var _ = fmt.Sprintf var _ = config.Token var _ = output.Print +var _ = strconv.Itoa var _ = timeutil.ParseLastISO var tasksCmd = &cobra.Command{ @@ -33,9 +35,9 @@ func init() { cmd := &cobra.Command{ Use: "create", Short: "Create Task", - Long: `This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the Call Control API Guide.`, + Long: "Creates a Work Item task. Requires `CJP_User` scope for authorization.", RunE: func(cmd *cobra.Command, args []string) error { - req := client.NewRequest(config.CcBaseURL, "POST", "/v1/tasks") + req := client.NewRequest(config.CcBaseURL, "POST", "/v2/tasks") if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -724,4 +726,36 @@ If the header is not present in the request or if gzip is not listed as one of t tasksCmd.AddCommand(cmd) } + { // update-2 + var taskId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-2", + Short: "Update Task", + Long: "Appends a Work Item message to an existing task. This is an asynchronous operation. Requires `CJP_User` scope for authorization.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "POST", "/v2/tasks/{taskId}/messages") + req.PathParam("taskId", taskId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&taskId, "task-id", "", "The unique ID of the Work Item task.") + cmd.MarkFlagRequired("task-id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + tasksCmd.AddCommand(cmd) + } + } diff --git a/cmd/cc/team.go b/cmd/cc/team.go index 618bcb0..2ec9523 100644 --- a/cmd/cc/team.go +++ b/cmd/cc/team.go @@ -70,19 +70,39 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime Use userId field to filter teams assocaited to provided user. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime Use userId field to filter teams assocaited to provided user. The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(name, description) The examples below show some search queries - \"Cisco\" - field==\"name\";value==\"Cisco\" - fields=in=(\"name\",\"description\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") - cmd.Flags().StringVar(&supervisorView, "supervisor-view", "", "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.") - cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ") + cmd.Flags().StringVar(&supervisorView, "supervisor-view", "", "If set to true, the API will only return data that user has access to, according to User Profile") + cmd.Flags().StringVar(&provisioningView, "provisioning-view", "", "If set to true, the API will only return data that user has access to, according to User Profile.") cmd.Flags().StringVar(&singleObjectResponse, "single-object-response", "", "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.") teamCmd.AddCommand(cmd) } { // create var orgid string + var active string + var name string + var rankQueuesForTeam string + var siteId string + var teamStatus string + var teamType string + var organizationId string + var id string + var version string + var dialedNumber string + var capacity string + var desktopLayoutId string + var skillProfileId string + var multiMediaProfileId string + var userIds string + var description string + var systemDefault string + var queueRankings string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -92,6 +112,26 @@ func init() { RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/team") req.PathParam("orgid", orgid) + req.QueryParam("active", active) + req.QueryParam("name", name) + req.QueryParam("rankQueuesForTeam", rankQueuesForTeam) + req.QueryParam("siteId", siteId) + req.QueryParam("teamStatus", teamStatus) + req.QueryParam("teamType", teamType) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("dialedNumber", dialedNumber) + req.QueryParam("capacity", capacity) + req.QueryParam("desktopLayoutId", desktopLayoutId) + req.QueryParam("skillProfileId", skillProfileId) + req.QueryParam("multiMediaProfileId", multiMediaProfileId) + req.QueryParam("userIds", userIds) + req.QueryParam("description", description) + req.QueryParam("systemDefault", systemDefault) + req.QueryParam("queueRankings", queueRankings) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -108,6 +148,26 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&active, "active", "", "") + cmd.Flags().StringVar(&name, "name", "", "") + cmd.Flags().StringVar(&rankQueuesForTeam, "rank-queues-for-team", "", "") + cmd.Flags().StringVar(&siteId, "site-id", "", "") + cmd.Flags().StringVar(&teamStatus, "team-status", "", "") + cmd.Flags().StringVar(&teamType, "team-type", "", "") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.Flags().StringVar(&version, "version", "", "") + cmd.Flags().StringVar(&dialedNumber, "dialed-number", "", "") + cmd.Flags().StringVar(&capacity, "capacity", "", "") + cmd.Flags().StringVar(&desktopLayoutId, "desktop-layout-id", "", "") + cmd.Flags().StringVar(&skillProfileId, "skill-profile-id", "", "") + cmd.Flags().StringVar(&multiMediaProfileId, "multi-media-profile-id", "", "") + cmd.Flags().StringVar(&userIds, "user-ids", "", "") + cmd.Flags().StringVar(&description, "description", "", "") + cmd.Flags().StringVar(&systemDefault, "system-default", "", "") + cmd.Flags().StringVar(&queueRankings, "queue-rankings", "", "") + cmd.Flags().StringVar(&createdTime, "created-time", "", "") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") teamCmd.AddCommand(cmd) @@ -238,6 +298,25 @@ func init() { { // update-id var orgid string var id string + var active string + var name string + var rankQueuesForTeam string + var siteId string + var teamStatus string + var teamType string + var organizationId string + var version string + var dialedNumber string + var capacity string + var desktopLayoutId string + var skillProfileId string + var multiMediaProfileId string + var userIds string + var description string + var systemDefault string + var queueRankings string + var createdTime string + var lastUpdatedTime string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -248,6 +327,26 @@ func init() { req := client.NewRequest(config.CcBaseURL, "PUT", "/organization/{orgid}/team/{id}") req.PathParam("orgid", orgid) req.PathParam("id", id) + req.QueryParam("active", active) + req.QueryParam("name", name) + req.QueryParam("rankQueuesForTeam", rankQueuesForTeam) + req.QueryParam("siteId", siteId) + req.QueryParam("teamStatus", teamStatus) + req.QueryParam("teamType", teamType) + req.QueryParam("organizationId", organizationId) + req.QueryParam("id", id) + req.QueryParam("version", version) + req.QueryParam("dialedNumber", dialedNumber) + req.QueryParam("capacity", capacity) + req.QueryParam("desktopLayoutId", desktopLayoutId) + req.QueryParam("skillProfileId", skillProfileId) + req.QueryParam("multiMediaProfileId", multiMediaProfileId) + req.QueryParam("userIds", userIds) + req.QueryParam("description", description) + req.QueryParam("systemDefault", systemDefault) + req.QueryParam("queueRankings", queueRankings) + req.QueryParam("createdTime", createdTime) + req.QueryParam("lastUpdatedTime", lastUpdatedTime) if bodyFile != "" { if err := req.SetBodyFile(bodyFile); err != nil { return err @@ -266,6 +365,25 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the Team.") cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&active, "active", "", "") + cmd.Flags().StringVar(&name, "name", "", "") + cmd.Flags().StringVar(&rankQueuesForTeam, "rank-queues-for-team", "", "") + cmd.Flags().StringVar(&siteId, "site-id", "", "") + cmd.Flags().StringVar(&teamStatus, "team-status", "", "") + cmd.Flags().StringVar(&teamType, "team-type", "", "") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "") + cmd.Flags().StringVar(&version, "version", "", "") + cmd.Flags().StringVar(&dialedNumber, "dialed-number", "", "") + cmd.Flags().StringVar(&capacity, "capacity", "", "") + cmd.Flags().StringVar(&desktopLayoutId, "desktop-layout-id", "", "") + cmd.Flags().StringVar(&skillProfileId, "skill-profile-id", "", "") + cmd.Flags().StringVar(&multiMediaProfileId, "multi-media-profile-id", "", "") + cmd.Flags().StringVar(&userIds, "user-ids", "", "") + cmd.Flags().StringVar(&description, "description", "", "") + cmd.Flags().StringVar(&systemDefault, "system-default", "", "") + cmd.Flags().StringVar(&queueRankings, "queue-rankings", "", "") + cmd.Flags().StringVar(&createdTime, "created-time", "", "") + cmd.Flags().StringVar(&lastUpdatedTime, "last-updated-time", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") teamCmd.AddCommand(cmd) diff --git a/cmd/cc/users.go b/cmd/cc/users.go index 034756d..51d176a 100644 --- a/cmd/cc/users.go +++ b/cmd/cc/users.go @@ -41,6 +41,8 @@ func init() { var buddyTeamAgentsOnly string var userInQueue string var queueId string + var includeAimappingCount string + var includeDynamicSkillsLimitReached string cmd := &cobra.Command{ Use: "list", Short: "List User(s)", @@ -58,6 +60,8 @@ func init() { req.QueryParam("buddyTeamAgentsOnly", buddyTeamAgentsOnly) req.QueryParam("userInQueue", userInQueue) req.QueryParam("queueId", queueId) + req.QueryParam("includeAIMappingCount", includeAimappingCount) + req.QueryParam("includeDynamicSkillsLimitReached", includeDynamicSkillsLimitReached) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -74,8 +78,8 @@ func init() { } cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") cmd.MarkFlagRequired("orgid") - cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter. ") - cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported") + cmd.Flags().StringVar(&filter, "filter", "", "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime The examples below show some search queries - id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\" - id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") - id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\") This parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide. Note: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter. ") + cmd.Flags().StringVar(&attributes, "attributes", "", "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.") cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(firstName, lastName, email) The examples below show some search queries - \"Cisco\" - field==\"firstName\";value==\"Cisco\" - fields=in=(\"firstName\",\"lastName\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") @@ -84,6 +88,8 @@ func init() { cmd.Flags().StringVar(&buddyTeamAgentsOnly, "buddy-team-agents-only", "", "If set to true, returns only users who are part of buddy teams without PBAC check.") cmd.Flags().StringVar(&userInQueue, "user-in-queue", "", "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.") cmd.Flags().StringVar(&queueId, "queue-id", "", "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.") + cmd.Flags().StringVar(&includeAimappingCount, "include-aimapping-count", "", "If set to true, the API response will include the count of each AI features mapped to the entity.") + cmd.Flags().StringVar(&includeDynamicSkillsLimitReached, "include-dynamic-skills-limit-reached", "", "If true, includes whether each user has reached the dynamic skills assignment limit.") usersCmd.AddCommand(cmd) } @@ -196,6 +202,18 @@ func init() { var search string var page string var pageSize string + var condition string + var skillId string + var skillValue string + var organizationId string + var id string + var version int64 + var skillName string + var skillType string + var weight int64 + var dynamicSkill bool + var createdTime int64 + var lastUpdatedTime int64 var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -214,6 +232,19 @@ func init() { } } else if bodyRaw != "" { req.SetBodyRaw(bodyRaw) + } else { + req.BodyString("condition", condition) + req.BodyString("skillId", skillId) + req.BodyString("skillValue", skillValue) + req.BodyString("organizationId", organizationId) + req.BodyString("id", id) + req.BodyInt("version", version, cmd.Flags().Changed("version")) + req.BodyString("skillName", skillName) + req.BodyString("skillType", skillType) + req.BodyInt("weight", weight, cmd.Flags().Changed("weight")) + req.BodyBool("dynamicSkill", dynamicSkill, cmd.Flags().Changed("dynamic-skill")) + req.BodyInt("createdTime", createdTime, cmd.Flags().Changed("created-time")) + req.BodyInt("lastUpdatedTime", lastUpdatedTime, cmd.Flags().Changed("last-updated-time")) } resp, statusCode, err := req.Do() if err != nil { @@ -227,12 +258,24 @@ func init() { cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(firstName, lastName, email) The examples below show some search queries - \"Cisco\" - field==\"firstName\";value==\"Cisco\" - fields=in=(\"firstName\",\"lastName\");value==\"Cisco\" ") cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") + cmd.Flags().StringVar(&condition, "condition", "", "") + cmd.Flags().StringVar(&skillId, "skill-id", "", "") + cmd.Flags().StringVar(&skillValue, "skill-value", "", "") + cmd.Flags().StringVar(&organizationId, "organization-id", "", "") + cmd.Flags().StringVar(&id, "id", "", "") + cmd.Flags().Int64Var(&version, "version", 0, "") + cmd.Flags().StringVar(&skillName, "skill-name", "", "") + cmd.Flags().StringVar(&skillType, "skill-type", "", "") + cmd.Flags().Int64Var(&weight, "weight", 0, "") + cmd.Flags().BoolVar(&dynamicSkill, "dynamic-skill", false, "") + cmd.Flags().Int64Var(&createdTime, "created-time", 0, "") + cmd.Flags().Int64Var(&lastUpdatedTime, "last-updated-time", 0, "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") usersCmd.AddCommand(cmd) } - { // get-provided-ids + { // get-ids var orgid string var page string var pageSize string @@ -242,8 +285,8 @@ func init() { var bodyRaw string var bodyFile string cmd := &cobra.Command{ - Use: "get-provided-ids", - Short: "Get specific Users by provided IDs", + Use: "get-ids", + Short: "Fetch User details by IDs", Long: `Retrieve an existing User's first name, last name and email by list of IDs in a given organization.`, RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CcBaseURL, "POST", "/organization/{orgid}/user/fetch-user-details-by-ids") @@ -344,7 +387,10 @@ func init() { var orgid string var id string var includeCount string + var includeUserProfileType string var includeSkillProfileAudit string + var includeReskillAuditInfo string + var includeSkillDetails string cmd := &cobra.Command{ Use: "get-id", Short: "Get specific User by ID", @@ -354,7 +400,10 @@ func init() { req.PathParam("orgid", orgid) req.PathParam("id", id) req.QueryParam("includeCount", includeCount) + req.QueryParam("includeUserProfileType", includeUserProfileType) req.QueryParam("includeSkillProfileAudit", includeSkillProfileAudit) + req.QueryParam("includeReskillAuditInfo", includeReskillAuditInfo) + req.QueryParam("includeSkillDetails", includeSkillDetails) if config.Paginate() { resp, statusCode, err := req.DoPaginated(false) if err != nil { @@ -373,42 +422,17 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the User.") cmd.MarkFlagRequired("id") - cmd.Flags().StringVar(&includeCount, "include-count", "", "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.") + cmd.Flags().StringVar(&includeCount, "include-count", "", "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to") + cmd.Flags().StringVar(&includeUserProfileType, "include-user-profile-type", "", "If set to true, the API response will include the user profile") cmd.Flags().StringVar(&includeSkillProfileAudit, "include-skill-profile-audit", "", "If set to true gives skill profile modification info.") + cmd.Flags().StringVar(&includeReskillAuditInfo, "include-reskill-audit-info", "", "If set to true gives skill profile and dynamic skill modification info.") + cmd.Flags().StringVar(&includeSkillDetails, "include-skill-details", "", "If set to true,the response includes skill information for each dynamic skill assignment") usersCmd.AddCommand(cmd) } { // update-id var orgid string var id string - var active bool - var agentProfileId string - var ciUserId string - var contactCenterEnabled bool - var email string - var firstName string - var lastName string - var siteId string - var userProfileId string - var organizationId string - var version int64 - var workPhone string - var mobile string - var broadCloudUserId string - var timezone string - var xspVersion string - var subscriptionId string - var teamIds []string - var skillProfileId string - var multimediaProfileId string - var deafultDialledNumber string - var externalIdentifier string - var imiUserCreated bool - var preferredSupervisorTeamId string - var userLevelBurnoutInclusion string - var userLevelAutoCsatinclusion string - var userLevelWellnessBreakReminders string - var userLevelSummariesInclusion string var bodyRaw string var bodyFile string cmd := &cobra.Command{ @@ -425,36 +449,6 @@ func init() { } } else if bodyRaw != "" { req.SetBodyRaw(bodyRaw) - } else { - req.BodyBool("active", active, cmd.Flags().Changed("active")) - req.BodyString("agentProfileId", agentProfileId) - req.BodyString("ciUserId", ciUserId) - req.BodyBool("contactCenterEnabled", contactCenterEnabled, cmd.Flags().Changed("contact-center-enabled")) - req.BodyString("email", email) - req.BodyString("firstName", firstName) - req.BodyString("lastName", lastName) - req.BodyString("siteId", siteId) - req.BodyString("userProfileId", userProfileId) - req.BodyString("organizationId", organizationId) - req.BodyString("id", id) - req.BodyInt("version", version, cmd.Flags().Changed("version")) - req.BodyString("workPhone", workPhone) - req.BodyString("mobile", mobile) - req.BodyString("broadCloudUserId", broadCloudUserId) - req.BodyString("timezone", timezone) - req.BodyString("xspVersion", xspVersion) - req.BodyString("subscriptionId", subscriptionId) - req.BodyStringSlice("teamIds", teamIds) - req.BodyString("skillProfileId", skillProfileId) - req.BodyString("multimediaProfileId", multimediaProfileId) - req.BodyString("deafultDialledNumber", deafultDialledNumber) - req.BodyString("externalIdentifier", externalIdentifier) - req.BodyBool("imiUserCreated", imiUserCreated, cmd.Flags().Changed("imi-user-created")) - req.BodyString("preferredSupervisorTeamId", preferredSupervisorTeamId) - req.BodyString("userLevelBurnoutInclusion", userLevelBurnoutInclusion) - req.BodyString("userLevelAutoCSATInclusion", userLevelAutoCsatinclusion) - req.BodyString("userLevelWellnessBreakReminders", userLevelWellnessBreakReminders) - req.BodyString("userLevelSummariesInclusion", userLevelSummariesInclusion) } resp, statusCode, err := req.Do() if err != nil { @@ -467,34 +461,6 @@ func init() { cmd.MarkFlagRequired("orgid") cmd.Flags().StringVar(&id, "id", "", "Resource ID of the User.") cmd.MarkFlagRequired("id") - cmd.Flags().BoolVar(&active, "active", false, "") - cmd.Flags().StringVar(&agentProfileId, "agent-profile-id", "", "") - cmd.Flags().StringVar(&ciUserId, "ci-user-id", "", "") - cmd.Flags().BoolVar(&contactCenterEnabled, "contact-center-enabled", false, "") - cmd.Flags().StringVar(&email, "email", "", "") - cmd.Flags().StringVar(&firstName, "first-name", "", "") - cmd.Flags().StringVar(&lastName, "last-name", "", "") - cmd.Flags().StringVar(&siteId, "site-id", "", "") - cmd.Flags().StringVar(&userProfileId, "user-profile-id", "", "") - cmd.Flags().StringVar(&organizationId, "organization-id", "", "") - cmd.Flags().Int64Var(&version, "version", 0, "") - cmd.Flags().StringVar(&workPhone, "work-phone", "", "") - cmd.Flags().StringVar(&mobile, "mobile", "", "") - cmd.Flags().StringVar(&broadCloudUserId, "broad-cloud-user-id", "", "") - cmd.Flags().StringVar(&timezone, "timezone", "", "") - cmd.Flags().StringVar(&xspVersion, "xsp-version", "", "") - cmd.Flags().StringVar(&subscriptionId, "subscription-id", "", "") - cmd.Flags().StringSliceVar(&teamIds, "team-ids", nil, "") - cmd.Flags().StringVar(&skillProfileId, "skill-profile-id", "", "") - cmd.Flags().StringVar(&multimediaProfileId, "multimedia-profile-id", "", "") - cmd.Flags().StringVar(&deafultDialledNumber, "deafult-dialled-number", "", "") - cmd.Flags().StringVar(&externalIdentifier, "external-identifier", "", "") - cmd.Flags().BoolVar(&imiUserCreated, "imi-user-created", false, "") - cmd.Flags().StringVar(&preferredSupervisorTeamId, "preferred-supervisor-team-id", "", "") - cmd.Flags().StringVar(&userLevelBurnoutInclusion, "user-level-burnout-inclusion", "", "") - cmd.Flags().StringVar(&userLevelAutoCsatinclusion, "user-level-auto-csatinclusion", "", "") - cmd.Flags().StringVar(&userLevelWellnessBreakReminders, "user-level-wellness-break-reminders", "", "") - cmd.Flags().StringVar(&userLevelSummariesInclusion, "user-level-summaries-inclusion", "", "") cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") usersCmd.AddCommand(cmd) @@ -581,4 +547,117 @@ func init() { usersCmd.AddCommand(cmd) } + { // bulk-update-dynamic-skills + var orgid string + var skillId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "bulk-update-dynamic-skills", + Short: "Bulk update User dynamic skills", + Long: `Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}") + req.PathParam("orgid", orgid) + req.PathParam("skillId", skillId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&skillId, "skill-id", "", "The unique identifier of the skill.") + cmd.MarkFlagRequired("skill-id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + usersCmd.AddCommand(cmd) + } + + { // get-dynamic-skill-id + var orgid string + var skillId string + var search string + var page string + var pageSize string + cmd := &cobra.Command{ + Use: "get-dynamic-skill-id", + Short: "Get users by dynamic skill ID", + Long: `Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "GET", "/organization/{orgid}/user/by-dynamic-skill-id/{skillId}") + req.PathParam("orgid", orgid) + req.PathParam("skillId", skillId) + req.QueryParam("search", search) + req.QueryParam("page", page) + req.QueryParam("pageSize", pageSize) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(false) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&skillId, "skill-id", "", "The dynamic skill ID to fetch users for") + cmd.MarkFlagRequired("skill-id") + cmd.Flags().StringVar(&search, "search", "", "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value) The examples below show some search queries - \"Cisco\" ") + cmd.Flags().StringVar(&page, "page", "", "Defines the number of displayed page. The page number starts from 0.") + cmd.Flags().StringVar(&pageSize, "page-size", "", "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.") + usersCmd.AddCommand(cmd) + } + + { // reskill-agents + var orgid string + var id string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "reskill-agents", + Short: "Reskill Agents", + Long: `Reskill agents by assigning or unassigning skills.`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CcBaseURL, "PATCH", "/organization/{orgid}/user/{id}/reskill") + req.PathParam("orgid", orgid) + req.PathParam("id", id) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgid, "orgid", "", "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.") + cmd.MarkFlagRequired("orgid") + cmd.Flags().StringVar(&id, "id", "", "Resource ID of the User.") + cmd.MarkFlagRequired("id") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + usersCmd.AddCommand(cmd) + } + } diff --git a/cmd/device/devices.go b/cmd/device/devices.go index bad61b5..bf06016 100644 --- a/cmd/device/devices.go +++ b/cmd/device/devices.go @@ -126,7 +126,7 @@ func init() { cmd := &cobra.Command{ Use: "create-mac-address", Short: "Create a Device by MAC Address", - Long: "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + Long: "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/devices") req.QueryParam("orgId", orgId) @@ -271,7 +271,7 @@ func init() { cmd := &cobra.Command{ Use: "create-activation-code", Short: "Create a Device Activation Code", - Long: "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + Long: "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "POST", "/devices/activationCode") req.QueryParam("orgId", orgId) diff --git a/cmd/device/locations.go b/cmd/device/locations.go new file mode 100644 index 0000000..528dc7a --- /dev/null +++ b/cmd/device/locations.go @@ -0,0 +1,354 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package device + +import ( + "fmt" + "strconv" + + cmd "github.com/Cloverhound/webex-cli/cmd" + "github.com/Cloverhound/webex-cli/internal/client" + "github.com/Cloverhound/webex-cli/internal/config" + "github.com/Cloverhound/webex-cli/internal/output" + "github.com/spf13/cobra" +) + +// Ensure imports are used. +var _ = fmt.Sprintf +var _ = config.Token +var _ = output.Print +var _ = strconv.Itoa + +var locationsCmd = &cobra.Command{ + Use: "locations", + Short: "Locations commands", +} + +func init() { + cmd.DeviceCmd.AddCommand(locationsCmd) + + { // list + var name string + var id string + var orgId string + var max string + cmd := &cobra.Command{ + Use: "list", + Short: "List Locations", + Long: "List locations for an organization.\n\n* Use query parameters to filter the result set by location name, ID, or organization.\n\n* Long result sets will be split into [pages](/docs/basics#pagination).\n\n* Searching and viewing locations in your organization requires an administrator or location administrator auth token with any of the following scopes: `spark-admin:locations_read`, `spark-admin:people_read` or `spark-admin:device_read`.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/locations") + req.QueryParam("name", name) + req.QueryParam("id", id) + req.QueryParam("orgId", orgId) + req.QueryParam("max", max) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&name, "name", "", "List locations whose name contains this string (case-insensitive).") + cmd.Flags().StringVar(&id, "id", "", "List locations by ID.") + cmd.Flags().StringVar(&orgId, "org-id", "", "List locations in this organization. Only admin users of another organization (such as partners) may use this parameter.") + cmd.Flags().StringVar(&max, "max", "", "Limit the maximum number of location in the response.") + locationsCmd.AddCommand(cmd) + } + + { // create + var orgId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create", + Short: "Create a Location", + Long: "Create a new Location for a given organization. Only an admin in the organization can create a new Location.\n\n* Creating a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Partners may specify `orgId` query parameter to create location in managed organization.\n\n* The following body parameters are required to create a new location: \n * `name`\n * `timeZone`\n * `preferredLanguage`\n * `address`\n * `announcementLanguage`.\n\n* `latitude`, `longitude` and `notes` are optional parameters to create a new location.\n\n* **Important:** While the `name` field supports up to 256 characters, locations that will be enabled for Webex Calling must have names with a maximum of 80 characters. If you plan to enable calling for this location, ensure the name does not exceed 80 characters to maintain compatibility with Control Hub and calling features.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/locations") + req.QueryParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&orgId, "org-id", "", "Create a location common attribute for this organization.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + locationsCmd.AddCommand(cmd) + } + + { // get + var locationId string + var orgId string + cmd := &cobra.Command{ + Use: "get", + Short: "Get Location Details", + Long: "Shows details for a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Use query parameter `orgId` to filter the result set by organization(optional).\n\n* Searching and viewing location in your organization requires an administrator or location administrator auth token with any of the following scopes:\n\n * `spark-admin:locations_read`\n * `spark-admin:people_read`\n * `spark-admin:device_read`", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/locations/{locationId}") + req.PathParam("locationId", locationId) + req.QueryParam("orgId", orgId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Get location common attributes for this organization.") + locationsCmd.AddCommand(cmd) + } + + { // update + var locationId string + var orgId string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update", + Short: "Update a Location", + Long: "Update details for a location, by ID.\n\n* Updating a location in your organization requires a full administrator or location administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Partners may specify `orgId` query parameter to update location in managed organization.\n\n* **Important:** While the `name` field supports up to 256 characters, locations that are enabled for Webex Calling must have names with a maximum of 80 characters. If the location is enabled for calling, ensure the name does not exceed 80 characters to maintain compatibility with Control Hub and calling features.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/locations/{locationId}") + req.PathParam("locationId", locationId) + req.QueryParam("orgId", orgId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "Update location common attributes for this location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Update location common attributes for this organization.") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + locationsCmd.AddCommand(cmd) + } + + { // delete + var locationId string + var orgId string + cmd := &cobra.Command{ + Use: "delete", + Short: "Delete Location", + Long: "Delete a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Deleting a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* NOTE: Disabling Webex Calling for a Webex Calling enabled location is required prior to deleting a location.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "DELETE", "/locations/{locationId}") + req.PathParam("locationId", locationId) + req.QueryParam("orgId", orgId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&orgId, "org-id", "", "Specify the organization for the location to be deleted.") + locationsCmd.AddCommand(cmd) + } + + { // list-floors + var locationId string + cmd := &cobra.Command{ + Use: "list-floors", + Short: "List Location Floors", + Long: "List location floors.\nRequires an administrator auth token with the `spark-admin:locations_read` scope.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/locations/{locationId}/floors") + req.PathParam("locationId", locationId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + locationsCmd.AddCommand(cmd) + } + + { // create-floor + var locationId string + var floorNumber int64 + var displayName string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "create-floor", + Short: "Create a Location Floor", + Long: "Create a new floor in the given location. The `displayName` parameter is optional, and omitting it will result in the creation of a floor without that value set.\nRequires an administrator auth token with the `spark-admin:locations_write` scope.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "POST", "/locations/{locationId}/floors") + req.PathParam("locationId", locationId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("floorNumber", floorNumber, cmd.Flags().Changed("floor-number")) + req.BodyString("displayName", displayName) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().Int64Var(&floorNumber, "floor-number", 0, "") + cmd.Flags().StringVar(&displayName, "display-name", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + locationsCmd.AddCommand(cmd) + } + + { // get-floor + var locationId string + var floorId string + cmd := &cobra.Command{ + Use: "get-floor", + Short: "Get Location Floor Details", + Long: "Shows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:locations_read` scope.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/locations/{locationId}/floors/{floorId}") + req.PathParam("locationId", locationId) + req.PathParam("floorId", floorId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&floorId, "floor-id", "", "A unique identifier for the floor.") + cmd.MarkFlagRequired("floor-id") + locationsCmd.AddCommand(cmd) + } + + { // update-floor + var locationId string + var floorId string + var floorNumber int64 + var displayName string + var bodyRaw string + var bodyFile string + cmd := &cobra.Command{ + Use: "update-floor", + Short: "Update a Location Floor", + Long: "Updates details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI. Include all details for the floor returned by a previous call to [Get Location Floor Details](/docs/api/v1/locations/get-location-floor-details). Omitting the optional `displayName` field will result in that field no longer being defined for the floor.\nRequires an administrator auth token with the `spark-admin:locations_write` scope.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "PUT", "/locations/{locationId}/floors/{floorId}") + req.PathParam("locationId", locationId) + req.PathParam("floorId", floorId) + if bodyFile != "" { + if err := req.SetBodyFile(bodyFile); err != nil { + return err + } + } else if bodyRaw != "" { + req.SetBodyRaw(bodyRaw) + } else { + req.BodyInt("floorNumber", floorNumber, cmd.Flags().Changed("floor-number")) + req.BodyString("displayName", displayName) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&floorId, "floor-id", "", "A unique identifier for the floor.") + cmd.MarkFlagRequired("floor-id") + cmd.Flags().Int64Var(&floorNumber, "floor-number", 0, "") + cmd.Flags().StringVar(&displayName, "display-name", "", "") + cmd.Flags().StringVar(&bodyRaw, "body", "", "Raw JSON body") + cmd.Flags().StringVar(&bodyFile, "body-file", "", "Path to JSON body file") + locationsCmd.AddCommand(cmd) + } + + { // delete-floor + var locationId string + var floorId string + cmd := &cobra.Command{ + Use: "delete-floor", + Short: "Delete a Location Floor", + Long: "Deletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:locations_write` scope.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "DELETE", "/locations/{locationId}/floors/{floorId}") + req.PathParam("locationId", locationId) + req.PathParam("floorId", floorId) + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&locationId, "location-id", "", "A unique identifier for the location.") + cmd.MarkFlagRequired("location-id") + cmd.Flags().StringVar(&floorId, "floor-id", "", "A unique identifier for the floor.") + cmd.MarkFlagRequired("floor-id") + locationsCmd.AddCommand(cmd) + } + +} diff --git a/cmd/device/xapi.go b/cmd/device/xapi.go index 8962768..86995bb 100644 --- a/cmd/device/xapi.go +++ b/cmd/device/xapi.go @@ -88,4 +88,40 @@ func init() { xapiCmd.AddCommand(cmd) } + { // query-schema + var deviceId string + var status string + var command string + cmd := &cobra.Command{ + Use: "query-schema", + Short: "Query Schema", + Long: "Query the schema for statuses and commands of Webex RoomOS Devices. You specify the target devices in the `deviceId` parameter in the URI. Querying command schemas requires the `spark:xapi_commands` scope and querying status schemas requires the `spark:xapi_statuses` scope.\n\nIf no `status` or `command` expressions are specified, the full schema is returned, including both status and command schemas. If you specify any expression, the response is limited to only the types you queried for. For example, if you provide a `status` expression but no `command` expression, only status schemas will be included in the result.\n\nSee the [xAPI section of the Device Developers Guide](/docs/api/guides/device-developers-guide#xapi) or the [xAPI Command Reference](https://roomos.cisco.com/xapi) for a description of status and command expressions.", + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/xapi/schema") + req.QueryParam("deviceId", deviceId) + req.QueryParam("deviceId", deviceId) + req.QueryParam("status", status) + req.QueryParam("status", status) + req.QueryParam("command", command) + req.QueryParam("command", command) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&deviceId, "device-id", "", "A list of device IDs to query schemas from. A request can contain at most 5 device IDs.") + cmd.Flags().StringVar(&status, "status", "", "A list of status key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_statuses` scope.") + cmd.Flags().StringVar(&command, "command", "", "A list of command key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_commands` scope.") + xapiCmd.AddCommand(cmd) + } + } diff --git a/cmd/mcp.go b/cmd/mcp.go new file mode 100644 index 0000000..d669e58 --- /dev/null +++ b/cmd/mcp.go @@ -0,0 +1,13 @@ +package cmd + +import "github.com/spf13/cobra" + +var McpCmd = &cobra.Command{ + Use: "mcp", + Short: "MCP server integration", + Long: "Commands for integrating with MCP-compatible AI clients (Claude Code, etc.).", +} + +func init() { + rootCmd.AddCommand(McpCmd) +} diff --git a/cmd/mcp/dispatcher.go b/cmd/mcp/dispatcher.go new file mode 100644 index 0000000..7a0717a --- /dev/null +++ b/cmd/mcp/dispatcher.go @@ -0,0 +1,316 @@ +package mcp + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "os" + "os/exec" + "strings" + "time" + + mcplib "github.com/mark3labs/mcp-go/mcp" + "github.com/mark3labs/mcp-go/server" +) + +var blockedPrefixes = []string{ + "login", + "logout", + "auth switch", + "auth set-org", + "auth clear-org", + "config set", + "post-install", + "update", + "mcp", +} + +// dangerousChars are rejected in any command token to prevent shell-style injection. +// exec.Command does not shell-eval, but these characters indicate misuse. +var dangerousChars = []string{"$", "`", "|", ";", "&&"} + +// readPrefixes are action verbs (and their hyphenated variants) that map to GET API calls. +var readPrefixes = []string{ + "list", + "get", + "download", + "export", + "search", + "status", + "describe", + "query", + "show", + "fetch", +} + +func registerTools(s *server.MCPServer, lg *usageLogger) { + s.AddTool( + mcplib.NewTool("webex_read", + mcplib.WithDescription( + "Execute a read-only Webex CLI command (list, get, download, export, search, status). "+ + "Maps to GET API calls — safe to auto-approve. "+ + "Provide the command without the 'webex' prefix "+ + "(e.g. 'calling people list' runs 'webex calling people list'). "+ + "Use webex_write for create/update/delete operations. "+ + "Use webex_help to discover valid commands and flags.", + ), + mcplib.WithString("command", + mcplib.Required(), + mcplib.Description("Read-only CLI command without 'webex' prefix (e.g. 'calling people list', 'cc site list', 'admin people get-my-own')"), + ), + mcplib.WithString("flags", + mcplib.Description(`Optional flags as a JSON object string (e.g. {"max": "10", "paginate": "true"}). Keys are flag names without '--'.`), + ), + ), + makeDispatchHandler(lg, true), + ) + + s.AddTool( + mcplib.NewTool("webex_write", + mcplib.WithDescription( + "Execute a Webex CLI command that creates, updates, or deletes a resource. "+ + "Maps to POST, PUT, PATCH, or DELETE API calls — requires explicit approval. "+ + "Provide the command without the 'webex' prefix "+ + "(e.g. 'messaging messages create'). "+ + "Use webex_read for list/get/download/export operations.", + ), + mcplib.WithString("command", + mcplib.Required(), + mcplib.Description("Write CLI command without 'webex' prefix (e.g. 'messaging messages create', 'cc team update', 'admin people delete')"), + ), + mcplib.WithString("flags", + mcplib.Description(`Optional flags as a JSON object string (e.g. {"room-id": "xxx", "text": "Hello"}). Keys are flag names without '--'.`), + ), + ), + makeDispatchHandler(lg, false), + ) + + s.AddTool( + mcplib.NewTool("webex_help", + mcplib.WithDescription( + "Get help text for any Webex CLI command or command group. "+ + "Returns usage, available flags, and subcommand descriptions. "+ + "Use this to explore what commands exist before calling webex_read or webex_write.", + ), + mcplib.WithString("command", + mcplib.Description("Command path to get help for (e.g. 'calling people', 'cc site'). Omit for top-level CLI help."), + ), + ), + handleHelp, + ) + + s.AddTool( + mcplib.NewTool("webex_usage", + mcplib.WithDescription( + "Query the MCP usage log to see recent commands executed via webex_read or webex_write. "+ + "Returns tool name, command, flags, status (ok/error), and elapsed time for each entry.", + ), + mcplib.WithNumber("limit", + mcplib.Description("Max log entries to return (1–100, default 20)"), + ), + mcplib.WithString("command_filter", + mcplib.Description("Substring to filter by command (e.g. 'calling', 'cc site')"), + ), + ), + makeUsageHandler(lg), + ) +} + +// makeDispatchHandler returns a handler for either webex_read (readOnly=true) or webex_write (readOnly=false). +func makeDispatchHandler(lg *usageLogger, readOnly bool) func(context.Context, mcplib.CallToolRequest) (*mcplib.CallToolResult, error) { + toolName := "webex_write" + if readOnly { + toolName = "webex_read" + } + + return func(ctx context.Context, req mcplib.CallToolRequest) (*mcplib.CallToolResult, error) { + command := strings.TrimSpace(req.GetString("command", "")) + if command == "" { + return mcplib.NewToolResultText("Error: command is required."), nil + } + + args := strings.Fields(command) + + // Blocklist check — join up to 2 tokens to cover two-word prefixes like "auth switch". + prefix := strings.Join(args[:min(2, len(args))], " ") + for _, blocked := range blockedPrefixes { + if strings.HasPrefix(prefix, blocked) { + return mcplib.NewToolResultText(fmt.Sprintf( + "Error: command '%s' is not permitted via the MCP server.", blocked, + )), nil + } + } + + // Injection guard: reject tokens containing shell-special characters. + for _, arg := range args { + for _, ch := range dangerousChars { + if strings.Contains(arg, ch) { + return mcplib.NewToolResultText( + "Error: command contains disallowed characters.", + ), nil + } + } + } + + // Read-only enforcement for webex_read. + if readOnly { + action := actionToken(args) + if action != "" && !isReadAction(action) { + return mcplib.NewToolResultText(fmt.Sprintf( + "Error: '%s' is a write operation (POST/PUT/PATCH/DELETE). Use the webex_write tool instead.", action, + )), nil + } + } + + // Force JSON output. + args = append(args, "--output=json") + + // Parse and append optional flags. + flagsStr := strings.TrimSpace(req.GetString("flags", "")) + if flagsStr != "" { + var flagMap map[string]string + if err := json.Unmarshal([]byte(flagsStr), &flagMap); err != nil { + return mcplib.NewToolResultText( + `Error: flags must be a JSON object string, e.g. {"max": "10"}`, + ), nil + } + for k, v := range flagMap { + if strings.ContainsAny(k, "= \t\n") || strings.ContainsAny(v, "\n") { + return mcplib.NewToolResultText( + "Error: flag key or value contains disallowed characters.", + ), nil + } + args = append(args, fmt.Sprintf("--%s=%s", k, v)) + } + } + + exe, err := os.Executable() + if err != nil { + return mcplib.NewToolResultText("Error: cannot resolve binary path: " + err.Error()), nil + } + + runCtx, cancel := context.WithTimeout(ctx, 60*time.Second) + defer cancel() + + var stdout, stderr bytes.Buffer + //nolint:gosec // args are validated above; exec.Command does not invoke a shell + c := exec.CommandContext(runCtx, exe, args...) + c.Stdout = &stdout + c.Stderr = &stderr + + start := time.Now() + runErr := c.Run() + elapsed := time.Since(start).Milliseconds() + + status := "ok" + if runErr != nil { + status = "error" + } + + _ = lg.Write(usageEntry{ + Time: time.Now().UTC().Format(time.RFC3339), + Tool: toolName, + Command: command, + Flags: flagsStr, + Status: status, + Ms: elapsed, + }) + + if runErr != nil { + errText := strings.TrimSpace(stderr.String()) + if errText == "" { + errText = runErr.Error() + } + return mcplib.NewToolResultText(fmt.Sprintf( + "Error running 'webex %s': %s", command, errText, + )), nil + } + return mcplib.NewToolResultText(strings.TrimSpace(stdout.String())), nil + } +} + +// actionToken returns the action verb from the command args. +// For "calling people list", it returns "list" (positional index 2). +// For two-token commands like "auth status", it returns "status" (positional index 1). +func actionToken(args []string) string { + var positional []string + for _, a := range args { + if !strings.HasPrefix(a, "-") { + positional = append(positional, a) + } + } + switch { + case len(positional) >= 3: + return strings.ToLower(positional[2]) + case len(positional) == 2: + return strings.ToLower(positional[1]) + case len(positional) == 1: + return strings.ToLower(positional[0]) + default: + return "" + } +} + +// isReadAction returns true if the verb maps to a GET API call. +func isReadAction(action string) bool { + for _, p := range readPrefixes { + if action == p || strings.HasPrefix(action, p+"-") { + return true + } + } + return false +} + +func handleHelp(_ context.Context, req mcplib.CallToolRequest) (*mcplib.CallToolResult, error) { + command := strings.TrimSpace(req.GetString("command", "")) + + exe, err := os.Executable() + if err != nil { + return mcplib.NewToolResultText("Error: cannot resolve binary path: " + err.Error()), nil + } + + var args []string + if command != "" { + args = append(args, strings.Fields(command)...) + } + args = append(args, "--help") + + ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second) + defer cancel() + + var out bytes.Buffer + //nolint:gosec // --help invocation only; no shell eval + c := exec.CommandContext(ctx, exe, args...) + c.Stdout = &out + c.Stderr = &out + _ = c.Run() + + return mcplib.NewToolResultText(out.String()), nil +} + +func makeUsageHandler(lg *usageLogger) func(context.Context, mcplib.CallToolRequest) (*mcplib.CallToolResult, error) { + return func(_ context.Context, req mcplib.CallToolRequest) (*mcplib.CallToolResult, error) { + limit := req.GetInt("limit", 20) + if limit < 1 { + limit = 1 + } + if limit > 100 { + limit = 100 + } + cmdFilter := req.GetString("command_filter", "") + + var path string + if lg != nil { + path = lg.path + } + entries := readUsage(path, limit, cmdFilter) + if entries == nil { + entries = []usageEntry{} + } + return jsonText(map[string]any{ + "count": len(entries), + "entries": entries, + }), nil + } +} diff --git a/cmd/mcp/logger.go b/cmd/mcp/logger.go new file mode 100644 index 0000000..094b817 --- /dev/null +++ b/cmd/mcp/logger.go @@ -0,0 +1,131 @@ +package mcp + +import ( + "bufio" + "encoding/json" + "fmt" + "os" + "path/filepath" + "strings" + "sync" + + mcplib "github.com/mark3labs/mcp-go/mcp" +) + +type usageEntry struct { + Time string `json:"time"` + Tool string `json:"tool"` + Command string `json:"command"` + Flags string `json:"flags"` + Status string `json:"status"` + Ms int64 `json:"ms"` +} + +type usageLogger struct { + path string + maxBytes int64 + maxFiles int + file *os.File + mu sync.Mutex +} + +func openLogger(path string, maxBytes int64, maxFiles int) (*usageLogger, error) { + if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil { + return nil, fmt.Errorf("create log dir: %w", err) + } + f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644) + if err != nil { + return nil, fmt.Errorf("open log: %w", err) + } + return &usageLogger{path: path, maxBytes: maxBytes, maxFiles: maxFiles, file: f}, nil +} + +func (l *usageLogger) Write(e usageEntry) error { + if l == nil { + return nil + } + l.mu.Lock() + defer l.mu.Unlock() + + b, err := json.Marshal(e) + if err != nil { + return err + } + if _, err := l.file.Write(append(b, '\n')); err != nil { + return err + } + info, err := l.file.Stat() + if err == nil && info.Size() >= l.maxBytes { + l.rotateLocked() + } + return nil +} + +// rotateLocked performs log rotation. Must be called with l.mu held. +func (l *usageLogger) rotateLocked() { + l.file.Close() + for i := l.maxFiles - 1; i >= 1; i-- { + os.Rename(rotatedPath(l.path, i), rotatedPath(l.path, i+1)) + } + os.Rename(l.path, rotatedPath(l.path, 1)) + f, err := os.OpenFile(l.path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644) + if err == nil { + l.file = f + } +} + +func (l *usageLogger) Close() { + if l == nil { + return + } + l.mu.Lock() + defer l.mu.Unlock() + if l.file != nil { + l.file.Close() + l.file = nil + } +} + +func rotatedPath(base string, n int) string { + ext := filepath.Ext(base) + stem := strings.TrimSuffix(base, ext) + return fmt.Sprintf("%s.%d%s", stem, n, ext) +} + +func readUsage(path string, limit int, cmdFilter string) []usageEntry { + f, err := os.Open(path) + if err != nil { + return nil + } + defer f.Close() + + var lines []string + scanner := bufio.NewScanner(f) + for scanner.Scan() { + if line := scanner.Text(); line != "" { + lines = append(lines, line) + } + } + + filter := strings.ToLower(cmdFilter) + var result []usageEntry + for i := len(lines) - 1; i >= 0 && len(result) < limit; i-- { + var e usageEntry + if err := json.Unmarshal([]byte(lines[i]), &e); err != nil { + continue + } + if filter != "" && !strings.Contains(strings.ToLower(e.Command), filter) { + continue + } + result = append(result, e) + } + return result +} + +func jsonText(v any) *mcplib.CallToolResult { + b, err := json.MarshalIndent(v, "", " ") + if err != nil { + return mcplib.NewToolResultText(fmt.Sprintf("error serialising result: %v", err)) + } + return mcplib.NewToolResultText(string(b)) +} diff --git a/cmd/mcp/resources.go b/cmd/mcp/resources.go new file mode 100644 index 0000000..1e66dc3 --- /dev/null +++ b/cmd/mcp/resources.go @@ -0,0 +1,121 @@ +package mcp + +import ( + "bufio" + "context" + "encoding/json" + "os" + "strings" + + cmd "github.com/Cloverhound/webex-cli/cmd" + mcplib "github.com/mark3labs/mcp-go/mcp" + "github.com/mark3labs/mcp-go/server" + "github.com/spf13/cobra" +) + +type commandEntry struct { + Path string `json:"path"` + Short string `json:"short"` +} + +func registerResources(s *server.MCPServer, logPath string) { + s.AddResource( + mcplib.NewResource( + "webex://commands", + "Webex CLI Command Tree", + mcplib.WithResourceDescription("JSON array of all available CLI commands with their paths and short descriptions"), + mcplib.WithMIMEType("application/json"), + ), + func(_ context.Context, _ mcplib.ReadResourceRequest) ([]mcplib.ResourceContents, error) { + cmds := walkCommands(cmd.RootCommand(), "") + b, err := json.MarshalIndent(cmds, "", " ") + if err != nil { + b = []byte("[]") + } + return []mcplib.ResourceContents{ + mcplib.TextResourceContents{ + URI: "webex://commands", + MIMEType: "application/json", + Text: string(b), + }, + }, nil + }, + ) + + s.AddResource( + mcplib.NewResource( + "webex://usage", + "Webex MCP Usage Log", + mcplib.WithResourceDescription("Last 50 raw JSONL lines from the MCP usage log"), + mcplib.WithMIMEType("text/plain"), + ), + func(_ context.Context, _ mcplib.ReadResourceRequest) ([]mcplib.ResourceContents, error) { + text := tailLog(logPath, 50) + return []mcplib.ResourceContents{ + mcplib.TextResourceContents{ + URI: "webex://usage", + MIMEType: "text/plain", + Text: text, + }, + }, nil + }, + ) +} + +func walkCommands(c *cobra.Command, parentPath string) []commandEntry { + var results []commandEntry + for _, child := range c.Commands() { + if child.Hidden || child.Name() == "completion" || child.Name() == "help" || child.Name() == "mcp" { + continue + } + name := cmdUseName(child) + path := name + if parentPath != "" { + path = parentPath + " " + name + } + var visibleSubs int + for _, sc := range child.Commands() { + if !sc.Hidden { + visibleSubs++ + } + } + if visibleSubs == 0 { + results = append(results, commandEntry{Path: path, Short: child.Short}) + } else { + results = append(results, walkCommands(child, path)...) + } + } + return results +} + +// cmdUseName returns the first word of a cobra command's Use field (strips positional args). +func cmdUseName(c *cobra.Command) string { + use := c.Use + if i := strings.IndexByte(use, ' '); i != -1 { + return use[:i] + } + return use +} + +func tailLog(path string, n int) string { + if path == "" { + return "" + } + f, err := os.Open(path) + if err != nil { + return "" + } + defer f.Close() + + var lines []string + scanner := bufio.NewScanner(f) + for scanner.Scan() { + if line := scanner.Text(); line != "" { + lines = append(lines, line) + if len(lines) > n { + lines = lines[1:] + } + } + } + return strings.Join(lines, "\n") +} diff --git a/cmd/mcp/serve.go b/cmd/mcp/serve.go new file mode 100644 index 0000000..4a2dac2 --- /dev/null +++ b/cmd/mcp/serve.go @@ -0,0 +1,154 @@ +package mcp + +import ( + "context" + "fmt" + "net" + "os" + "os/signal" + "path/filepath" + "syscall" + "time" + + cmd "github.com/Cloverhound/webex-cli/cmd" + "github.com/mark3labs/mcp-go/server" + "github.com/spf13/cobra" +) + +var ( + flagLogPath string + flagLogMaxBytes int64 + flagLogMaxFiles int + flagHTTP bool + flagHTTPAddr string +) + +var serveCmd = &cobra.Command{ + Use: "serve", + Short: "Start an MCP server exposing Webex tools to AI clients", + Long: `Start a Model Context Protocol (MCP) server. + +Defaults to stdio transport (Claude Code, Codex, Cursor): + webex mcp serve + +Use --http for HTTP transport (Claude Desktop and other HTTP-based clients): + webex mcp serve --http + +The HTTP server binds to loopback only and cannot be exposed on public interfaces. +Use 'webex mcp stop' to stop a running HTTP server. + +Authentication is shared with the CLI — run 'webex login' once and the server +uses the same stored credentials with automatic token refresh. + +Tools: + webex_read Execute a read-only CLI command (list, get, download, export) + webex_write Execute a command that creates, updates, or deletes a resource + webex_help Get help text for any command or command group + webex_usage Query the MCP usage log (recent commands, timing) + +Resources: + webex://commands JSON array of all available CLI commands + webex://usage Last 50 lines of the raw usage log + +HTTP transport flags: + --http Enable HTTP transport instead of stdio + --http-addr Listen address — must be loopback (default 127.0.0.1:47890) + +Usage log flags: + --log-path Path for the usage log (default ~/.webex-mcp/usage.log) + --log-max-size Max log file size in bytes before rotation (default 5MB) + --log-max-files Number of rotated log files to keep (default 3)`, + RunE: func(c *cobra.Command, args []string) error { + logPath := flagLogPath + if logPath == "" { + home, err := os.UserHomeDir() + if err != nil { + home = "." + } + logPath = filepath.Join(home, ".webex-mcp", "usage.log") + } + + lg, err := openLogger(logPath, flagLogMaxBytes, flagLogMaxFiles) + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: usage log unavailable: %v\n", err) + } + defer lg.Close() + + s := server.NewMCPServer( + "Webex MCP", + "2.0.0", + server.WithToolCapabilities(false), + ) + registerResources(s, logPath) + registerTools(s, lg) + + if flagHTTP { + host, _, err := net.SplitHostPort(flagHTTPAddr) + if err != nil { + return fmt.Errorf("invalid --http-addr %q: %w", flagHTTPAddr, err) + } + ip := net.ParseIP(host) + if ip == nil || !ip.IsLoopback() { + return fmt.Errorf("--http-addr must bind to a loopback address (127.x.x.x or ::1), got %q", host) + } + + pidPath := defaultPIDPath() + if err := writePIDFile(pidPath); err != nil { + fmt.Fprintf(os.Stderr, "Warning: could not write PID file: %v\n", err) + } else { + defer os.Remove(pidPath) + } + + hs := server.NewStreamableHTTPServer(s, + server.WithEndpointPath("/mcp"), + server.WithHeartbeatInterval(30*time.Second), + ) + + sigCh := make(chan os.Signal, 1) + signal.Notify(sigCh, os.Interrupt, syscall.SIGTERM) + + errCh := make(chan error, 1) + go func() { errCh <- hs.Start(flagHTTPAddr) }() + + fmt.Fprintf(os.Stderr, "Webex MCP server ready (HTTP transport on http://%s/mcp)\n", flagHTTPAddr) + fmt.Fprintf(os.Stderr, "Stop with: webex mcp stop\n") + + select { + case sig := <-sigCh: + fmt.Fprintf(os.Stderr, "\nReceived %s, shutting down...\n", sig) + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + return hs.Shutdown(ctx) + case err := <-errCh: + return err + } + } + + fmt.Fprintln(os.Stderr, "Webex MCP server ready (stdio transport)") + return server.ServeStdio(s) + }, +} + +func defaultPIDPath() string { + home, err := os.UserHomeDir() + if err != nil { + home = "." + } + return filepath.Join(home, ".webex-mcp", "server.pid") +} + +func writePIDFile(path string) error { + if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil { + return err + } + return os.WriteFile(path, []byte(fmt.Sprintf("%d\n", os.Getpid())), 0644) +} + +func init() { + serveCmd.Flags().BoolVar(&flagHTTP, "http", false, "Start HTTP server instead of stdio transport") + serveCmd.Flags().StringVar(&flagHTTPAddr, "http-addr", "127.0.0.1:47890", "HTTP listen address — must be loopback (used with --http)") + serveCmd.Flags().StringVar(&flagLogPath, "log-path", "", "Usage log path (default ~/.webex-mcp/usage.log)") + serveCmd.Flags().Int64Var(&flagLogMaxBytes, "log-max-size", 5*1024*1024, "Max log file size in bytes before rotation") + serveCmd.Flags().IntVar(&flagLogMaxFiles, "log-max-files", 3, "Number of rotated log files to keep") + cmd.McpCmd.AddCommand(serveCmd) +} diff --git a/cmd/mcp/stop.go b/cmd/mcp/stop.go new file mode 100644 index 0000000..4d59f34 --- /dev/null +++ b/cmd/mcp/stop.go @@ -0,0 +1,61 @@ +package mcp + +import ( + "fmt" + "os" + "strconv" + "strings" + "syscall" + + cmd "github.com/Cloverhound/webex-cli/cmd" + "github.com/spf13/cobra" +) + +var stopCmd = &cobra.Command{ + Use: "stop", + Short: "Stop a running HTTP MCP server", + Long: `Stop a running 'webex mcp serve --http' server. + +Reads the PID from ~/.webex-mcp/server.pid, sends SIGTERM, and the server +shuts down gracefully. The PID file is removed automatically on shutdown.`, + RunE: func(c *cobra.Command, args []string) error { + pidPath := defaultPIDPath() + + data, err := os.ReadFile(pidPath) + if err != nil { + if os.IsNotExist(err) { + return fmt.Errorf("no running MCP server found (PID file not at %s)", pidPath) + } + return fmt.Errorf("reading PID file: %w", err) + } + + pid, err := strconv.Atoi(strings.TrimSpace(string(data))) + if err != nil { + os.Remove(pidPath) + return fmt.Errorf("invalid PID file contents — removed stale file") + } + + proc, err := os.FindProcess(pid) + if err != nil { + os.Remove(pidPath) + return fmt.Errorf("process %d not found: %w", pid, err) + } + + // Signal 0 checks process existence without side effects. + if err := proc.Signal(syscall.Signal(0)); err != nil { + os.Remove(pidPath) + return fmt.Errorf("MCP server (PID %d) is not running — removed stale PID file", pid) + } + + if err := proc.Signal(syscall.SIGTERM); err != nil { + return fmt.Errorf("stopping MCP server (PID %d): %w", pid, err) + } + + fmt.Printf("Stopped MCP server (PID %d)\n", pid) + return nil + }, +} + +func init() { + cmd.McpCmd.AddCommand(stopCmd) +} diff --git a/cmd/meetings/people.go b/cmd/meetings/people.go index f9cc31d..f5c40d5 100644 --- a/cmd/meetings/people.go +++ b/cmd/meetings/people.go @@ -40,7 +40,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List People", - Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/people") req.QueryParam("email", email) diff --git a/cmd/meetings/slidosecurepremium.go b/cmd/meetings/slidosecurepremium.go new file mode 100644 index 0000000..8eba91a --- /dev/null +++ b/cmd/meetings/slidosecurepremium.go @@ -0,0 +1,75 @@ +// Code generated by codegen/generate_cli.py; DO NOT EDIT. + +package meetings + +import ( + "fmt" + + cmd "github.com/Cloverhound/webex-cli/cmd" + "github.com/Cloverhound/webex-cli/internal/client" + "github.com/Cloverhound/webex-cli/internal/config" + "github.com/Cloverhound/webex-cli/internal/output" + "github.com/spf13/cobra" +) + +// Ensure imports are used. +var _ = fmt.Sprintf +var _ = config.Token +var _ = output.Print + +var slidosecurepremiumCmd = &cobra.Command{ + Use: "slidosecurepremium", + Short: "Slidosecurepremium commands", +} + +func init() { + cmd.MeetingsCmd.AddCommand(slidosecurepremiumCmd) + + { // list-compliance-events + var sessionOrgId string + var sessionId string + var start string + cmd := &cobra.Command{ + Use: "list-compliance-events", + Short: "List Compliance Events", + Long: `Lists events representing actions that occurred during a Slido Secure Premium session (creating a poll, modifying a poll, activating a poll, posting an answer, etc.) + +Events capture who performed the action and on what resource. + +The events are paginated by the server into pages of max 256 items per page without any order. + +The events are available within 15 minutes after they happened. + +Every resource has properties: +* type - event type + +* ... event specific ids + +* ... event specific properties +`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/slido/compliance/events") + req.QueryParam("sessionOrgId", sessionOrgId) + req.QueryParam("sessionId", sessionId) + req.QueryParam("start", start) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&sessionOrgId, "session-org-id", "", "Webex organization UUID.") + cmd.Flags().StringVar(&sessionId, "session-id", "", "Webex meeting instance ID (`{meetingSeriesId}_I_{conferenceId}`).") + cmd.Flags().StringVar(&start, "start", "", "Pagination token. Returned in the response body as the `next` property.") + slidosecurepremiumCmd.AddCommand(cmd) + } + +} diff --git a/cmd/messaging/events.go b/cmd/messaging/events.go index 2a715c9..b9a5300 100644 --- a/cmd/messaging/events.go +++ b/cmd/messaging/events.go @@ -34,6 +34,7 @@ func init() { var from string var to string var max string + var serviceType string var last string cmd := &cobra.Command{ Use: "list", @@ -56,6 +57,7 @@ Long result sets will be split into [pages](/docs/basics#pagination).`, req.QueryParam("from", from) req.QueryParam("to", to) req.QueryParam("max", max) + req.QueryParam("serviceType", serviceType) if config.Paginate() { resp, statusCode, err := req.DoPaginated(true) if err != nil { @@ -76,6 +78,7 @@ Long result sets will be split into [pages](/docs/basics#pagination).`, cmd.Flags().StringVar(&from, "from", "", "List events which occurred after a specific date and time.") cmd.Flags().StringVar(&to, "to", "", "List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time.") cmd.Flags().StringVar(&max, "max", "", "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.") + cmd.Flags().StringVar(&serviceType, "service-type", "", "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.") cmd.Flags().StringVar(&last, "last", "", "Time range shorthand (e.g. 1h, 30m, 24h). Sets --from automatically.") eventsCmd.AddCommand(cmd) } diff --git a/cmd/messaging/hds.go b/cmd/messaging/hds.go index 68103c7..e7bb172 100644 --- a/cmd/messaging/hds.go +++ b/cmd/messaging/hds.go @@ -249,4 +249,62 @@ To obtain the Cluster ID needed for this API, use the [Get organization details hdsCmd.AddCommand(cmd) } + { // get-database-org-2 + var organizationId string + cmd := &cobra.Command{ + Use: "get-database-org-2", + Short: "Get database details for the HDS organization", + Long: `Retrieve details of database information for an HDS organization, such as database type and version used. +To obtain the Organization ID needed for this API, use the [Organizations API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/organizations/{organizationId}/database") + req.PathParam("organizationId", organizationId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Unique ID of the HDS organization") + cmd.MarkFlagRequired("organization-id") + hdsCmd.AddCommand(cmd) + } + + { // get-multi-tenant-org-2 + var organizationId string + cmd := &cobra.Command{ + Use: "get-multi-tenant-org-2", + Short: "Get Multi-Tenant HDS organization details", + Long: `Retrieve details of Multi-Tenant HDS organization such as Organization Name and ID, CMK state and state of Tenants Organizations. +To obtain the Organization ID needed for this API, use the [Organizations API]()`, + RunE: func(cmd *cobra.Command, args []string) error { + req := client.NewRequest(config.CallingBaseURL, "GET", "/hds/organizations/{organizationId}/tenants") + req.PathParam("organizationId", organizationId) + if config.Paginate() { + resp, statusCode, err := req.DoPaginated(true) + if err != nil { + return err + } + return output.Print(resp, statusCode) + } + resp, statusCode, err := req.Do() + if err != nil { + return err + } + return output.Print(resp, statusCode) + }, + } + cmd.Flags().StringVar(&organizationId, "organization-id", "", "Unique ID of the HDS organization.") + cmd.MarkFlagRequired("organization-id") + hdsCmd.AddCommand(cmd) + } + } diff --git a/cmd/messaging/people.go b/cmd/messaging/people.go index ce1721c..dbc56e3 100644 --- a/cmd/messaging/people.go +++ b/cmd/messaging/people.go @@ -40,7 +40,7 @@ func init() { cmd := &cobra.Command{ Use: "list", Short: "List People", - Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + Long: "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", RunE: func(cmd *cobra.Command, args []string) error { req := client.NewRequest(config.CallingBaseURL, "GET", "/people") req.QueryParam("email", email) diff --git a/cmd/postinstall.go b/cmd/postinstall.go index 1737b8a..cd2d58d 100644 --- a/cmd/postinstall.go +++ b/cmd/postinstall.go @@ -16,7 +16,17 @@ import ( "github.com/spf13/cobra" ) -const skillURL = "https://raw.githubusercontent.com/Cloverhound/webex-cli/main/skill/SKILL.md" +const skillBaseURL = "https://raw.githubusercontent.com/Cloverhound/webex-cli/main/skill/" + +var skillSubPaths = []string{ + "SKILL.md", + "admin/SKILL.md", + "calling/SKILL.md", + "cc/SKILL.md", + "device/SKILL.md", + "meetings/SKILL.md", + "messaging/SKILL.md", +} const coworkName = "Claude Cowork" @@ -192,7 +202,7 @@ func setupAgentSkills() error { } fmt.Print("Downloading Webex skill...") - skillContent, err := downloadSkill() + skillFiles, err := downloadSkillFiles() if err != nil { fmt.Println(" failed") return fmt.Errorf("downloading skill: %w", err) @@ -206,18 +216,25 @@ func setupAgentSkills() error { } if p.Name == coworkName { zipPath := filepath.Join(home, "Downloads", "webex-cli-skill.zip") - if err := buildSkillZip(zipPath, "webex-cli", skillContent); err != nil { + if err := buildSkillZip(zipPath, "webex-cli", skillFiles); err != nil { fmt.Printf(" %s: failed (%v)\n", p.Name, err) } else { fmt.Printf(" %s: saved to %s\n", p.Name, zipPath) printCoworkInstructions(zipPath) } } else { - dest := filepath.Join(home, p.SkillDir, "SKILL.md") - if err := installSkill(dest, skillContent); err != nil { - fmt.Printf(" %s: failed (%v)\n", p.Name, err) - } else { - fmt.Printf(" %s: installed to %s\n", p.Name, dest) + skillDir := filepath.Join(home, p.SkillDir) + failed := false + for subPath, content := range skillFiles { + dest := filepath.Join(skillDir, filepath.FromSlash(subPath)) + if err := installSkill(dest, content); err != nil { + fmt.Printf(" %s: failed installing %s (%v)\n", p.Name, subPath, err) + failed = true + break + } + } + if !failed { + fmt.Printf(" %s: installed to %s\n", p.Name, skillDir) } } } @@ -243,18 +260,24 @@ func agentDetected(home string, p agentPlatform) bool { return err == nil && info.IsDir() } -func downloadSkill() ([]byte, error) { - resp, err := http.Get(skillURL) - if err != nil { - return nil, err - } - defer resp.Body.Close() - - if resp.StatusCode != http.StatusOK { - return nil, fmt.Errorf("HTTP %d", resp.StatusCode) +func downloadSkillFiles() (map[string][]byte, error) { + files := make(map[string][]byte) + for _, subPath := range skillSubPaths { + resp, err := http.Get(skillBaseURL + subPath) + if err != nil { + return nil, fmt.Errorf("downloading %s: %w", subPath, err) + } + body, err := io.ReadAll(resp.Body) + resp.Body.Close() + if err != nil { + return nil, fmt.Errorf("reading %s: %w", subPath, err) + } + if resp.StatusCode != http.StatusOK { + return nil, fmt.Errorf("%s: HTTP %d", subPath, resp.StatusCode) + } + files[subPath] = body } - - return io.ReadAll(resp.Body) + return files, nil } func printCoworkInstructions(zipPath string) { @@ -284,17 +307,20 @@ func printCoworkInstructions(zipPath string) { fmt.Println(box.Render(content)) } -func buildSkillZip(dest, skillName string, skillContent []byte) error { +func buildSkillZip(dest, skillName string, files map[string][]byte) error { var buf bytes.Buffer w := zip.NewWriter(&buf) - f, err := w.Create(skillName + "/SKILL.md") - if err != nil { - return fmt.Errorf("creating zip entry: %w", err) - } - if _, err := f.Write(skillContent); err != nil { - return fmt.Errorf("writing zip entry: %w", err) + for subPath, content := range files { + f, err := w.Create(skillName + "/" + subPath) + if err != nil { + return fmt.Errorf("creating zip entry %s: %w", subPath, err) + } + if _, err := f.Write(content); err != nil { + return fmt.Errorf("writing zip entry %s: %w", subPath, err) + } } + if err := w.Close(); err != nil { return fmt.Errorf("closing zip: %w", err) } diff --git a/cmd/root.go b/cmd/root.go index d308808..cbf0297 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -120,6 +120,9 @@ var rootCmd = &cobra.Command{ }, } +// RootCommand returns the root cobra command for external introspection. +func RootCommand() *cobra.Command { return rootCmd } + func Execute() error { // Remove "required" from --orgid/--org-id flags on all subcommands. // This allows PersistentPreRunE to auto-populate from config/login. diff --git a/cmd/skillupdate.go b/cmd/skillupdate.go index cdf3054..e212afd 100644 --- a/cmd/skillupdate.go +++ b/cmd/skillupdate.go @@ -22,7 +22,7 @@ func checkSkillUpdates() error { } fmt.Print("Checking for skill updates...") - latest, err := downloadSkill() + latest, err := downloadSkillFiles() if err != nil { fmt.Println(" failed") return err @@ -34,14 +34,27 @@ func checkSkillUpdates() error { if p.SkillDir == "" { continue // skip Cowork (no filesystem path) } - path := filepath.Join(home, p.SkillDir, "SKILL.md") - current, err := os.ReadFile(path) + skillDir := filepath.Join(home, p.SkillDir) + rootPath := filepath.Join(skillDir, "SKILL.md") + current, err := os.ReadFile(rootPath) if err == nil { - if !bytes.Equal(current, latest) { - actions = append(actions, skillAction{p, path, "outdated"}) + outdated := !bytes.Equal(current, latest["SKILL.md"]) + if !outdated { + for subPath := range latest { + if subPath == "SKILL.md" { + continue + } + if _, serr := os.Stat(filepath.Join(skillDir, filepath.FromSlash(subPath))); serr != nil { + outdated = true + break + } + } + } + if outdated { + actions = append(actions, skillAction{p, skillDir, "outdated"}) } } else if agentDetected(home, p) { - actions = append(actions, skillAction{p, path, "new"}) + actions = append(actions, skillAction{p, skillDir, "new"}) } } @@ -101,12 +114,21 @@ func checkSkillUpdates() error { for _, name := range selected { for _, a := range actions { if a.Platform.Name == name { - if err := installSkill(a.Path, latest); err != nil { - fmt.Printf(" %s: failed (%v)\n", a.Platform.Name, err) - } else if a.Status == "outdated" { - fmt.Printf(" %s: updated %s\n", a.Platform.Name, a.Path) - } else { - fmt.Printf(" %s: installed to %s\n", a.Platform.Name, a.Path) + failed := false + for subPath, content := range latest { + dest := filepath.Join(a.Path, filepath.FromSlash(subPath)) + if err := installSkill(dest, content); err != nil { + fmt.Printf(" %s: failed installing %s (%v)\n", a.Platform.Name, subPath, err) + failed = true + break + } + } + if !failed { + if a.Status == "outdated" { + fmt.Printf(" %s: updated %s\n", a.Platform.Name, a.Path) + } else { + fmt.Printf(" %s: installed to %s\n", a.Platform.Name, a.Path) + } } } } diff --git a/codegen/generate_skills.py b/codegen/generate_skills.py new file mode 100644 index 0000000..832b7c5 --- /dev/null +++ b/codegen/generate_skills.py @@ -0,0 +1,208 @@ +#!/usr/bin/env python3 +"""Generate Command Reference sections in skill//SKILL.md from api_spec.json. + +Run after extract_api_spec.py + generate_cli.py as part of `make codegen`. +Adds/updates a sentinel-bounded block at the end of each skill file without +touching the hand-written content above it. +""" + +import json +import os +import re +import sys + +SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__)) +CLI_DIR = os.path.dirname(SCRIPT_DIR) +SPEC_PATH = os.path.join(SCRIPT_DIR, "api_spec.json") +SKILL_DIR = os.path.join(CLI_DIR, "skill") + +SENTINEL_START = "" +SENTINEL_END = "" + +COLLECTIONS = { + "Webex Cloud Calling": "calling", + "Webex Contact Center": "cc", + "Webex Admin": "admin", + "Webex Device": "device", + "Webex Meetings": "meetings", + "Webex Messaging": "messaging", +} + +# Commands replaced by hand-written custom_*.go — omit from generated reference +# since their actual flags differ from the Postman spec. +SKIP_COMMANDS = { + "Webex Cloud Calling": { + "announcement-repository": { + "upload-binary-greeting", + "upload-binary-greeting-2", + "update-binary-greeting", + "update-binary-greeting-2", + }, + "user-call": { + "update-intercept-greeting-person", + "update-busy-voicemail-greeting-person", + "update-no-answer-voicemail-greeting-person", + }, + "call-settings-for-me": { + "upload-voicemail-busy-greeting", + "upload-voicemail-no-answer-greeting", + }, + "virtual-line-call": { + "update-intercept-greeting", + "update-busy-voicemail-greeting", + "update-no-answer-voicemail-greeting", + }, + "workspace-call": { + "upload-intercept-announcement-file", + "update-busy-voicemail-greeting-place", + "update-no-answer-voicemail-greeting-place", + }, + }, +} + +# Groups skipped entirely during Go codegen — still document them here since +# hand-written custom implementations exist and need to be discoverable. +SKIP_GROUPS_CODEGEN = { + "Webex Contact Center": {"search"}, +} + + +def camel_to_kebab(name): + s = re.sub(r'([a-z0-9])([A-Z])', r'\1-\2', name) + return s.lower() + + +def method_sort_key(method): + return {'GET': 0, 'POST': 1, 'PUT': 2, 'PATCH': 3, 'DELETE': 4}.get(method, 5) + + +def format_flags(ep): + """Return a markdown string listing all flags for one endpoint.""" + parts = [] + seen = set() + + for p in ep.get('path_params', []): + flag = camel_to_kebab(p['name']) + if flag not in seen: + seen.add(flag) + parts.append(f"`--{flag}` *(required)*") + + for p in ep.get('query_params', []): + flag = camel_to_kebab(p['name']) + if flag not in seen: + seen.add(flag) + parts.append(f"`--{flag}`") + + # --last is added automatically whenever 'from' is a query param + if any(p['name'] == 'from' for p in ep.get('query_params', [])): + parts.append("`--last`") + + if ep.get('has_body'): + if not ep.get('complex_body'): + for f in ep.get('body_fields', []): + flag = camel_to_kebab(f['name']) + if flag not in seen: + seen.add(flag) + parts.append(f"`--{flag}`") + parts.append("`--body`") + parts.append("`--body-file`") + + return ", ".join(parts) if parts else "—" + + +def generate_command_reference(area_cmd, groups, collection_name): + """Build the full ## Command Reference markdown block for one area.""" + skip_groups = SKIP_GROUPS_CODEGEN.get(collection_name, set()) + skip_cmds = SKIP_COMMANDS.get(collection_name, {}) + + lines = [ + "## Command Reference", + "", + "> Auto-generated from Postman collections. Run `make codegen` to update.", + ] + + for group_data in groups: + group = group_data['group'] + endpoints = group_data.get('endpoints', []) + + if not endpoints or group in skip_groups: + continue + + group_skip = skip_cmds.get(group, set()) + visible = [ep for ep in endpoints if ep['command'] not in group_skip] + if not visible: + continue + + visible.sort(key=lambda ep: method_sort_key(ep['method'])) + + lines += [ + "", + f"### {group}", + "", + "| Command | Flags |", + "|---|---|", + ] + for ep in visible: + lines.append(f"| `{ep['command']}` | {format_flags(ep)} |") + + return "\n".join(lines) + "\n" + + +def update_skill_file(skill_path, generated_block): + """Replace or append the sentinel block in an existing skill file. + + Returns True if the file was modified, False if content was unchanged. + """ + if not os.path.exists(skill_path): + print(f" WARNING: {skill_path} not found — skipping") + return False + + with open(skill_path) as f: + content = f.read() + + block = f"{SENTINEL_START}\n{generated_block}\n{SENTINEL_END}" + + start_idx = content.find(SENTINEL_START) + end_idx = content.find(SENTINEL_END) + + if start_idx != -1 and end_idx != -1: + new_content = content[:start_idx] + block + content[end_idx + len(SENTINEL_END):] + else: + new_content = content.rstrip("\n") + "\n\n" + block + "\n" + + if new_content == content: + return False + + with open(skill_path, 'w') as f: + f.write(new_content) + return True + + +def main(): + if not os.path.exists(SPEC_PATH): + print("ERROR: api_spec.json not found — run 'make download' first.") + sys.exit(1) + + with open(SPEC_PATH) as f: + spec = json.load(f) + + for collection_name, area_cmd in COLLECTIONS.items(): + if collection_name not in spec: + print(f" {collection_name}: not in spec — skipping") + continue + + groups = spec[collection_name] + block = generate_command_reference(area_cmd, groups, collection_name) + + skill_path = os.path.join(SKILL_DIR, area_cmd, "SKILL.md") + changed = update_skill_file(skill_path, block) + + cmd_count = sum(len(g.get('endpoints', [])) for g in groups) + status = "updated" if changed else "unchanged" + print(f" {area_cmd}: {len(groups)} groups, {cmd_count} commands → {status}") + + print("\nDone.") + + +if __name__ == "__main__": + main() diff --git a/codegen/postman/Webex Admin.postman_collection.json b/codegen/postman/Webex Admin.postman_collection.json index 904e681..38591e2 100644 --- a/codegen/postman/Webex Admin.postman_collection.json +++ b/codegen/postman/Webex Admin.postman_collection.json @@ -13683,9 +13683,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "response": [ @@ -13736,9 +13741,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Not Found" @@ -13790,9 +13800,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Gone" @@ -13844,9 +13859,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Service Unavailable" @@ -13898,9 +13918,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Gateway Timeout" @@ -13952,9 +13977,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -14006,9 +14036,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Internal Server Error" @@ -14060,9 +14095,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Precondition Required" @@ -14133,9 +14173,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "OK" @@ -14187,9 +14232,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Conflict" @@ -14241,9 +14291,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Too Many Requests" @@ -14295,9 +14350,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Method Not Allowed" @@ -14349,9 +14409,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Bad Gateway" @@ -14403,9 +14468,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Forbidden" @@ -14457,9 +14527,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Bad Request" @@ -14511,9 +14586,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Unsupported Media Type" @@ -14565,9 +14645,14 @@ "description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.", "key": "max", "value": "100" + }, + { + "description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.", + "key": "serviceType", + "value": "calling" } ], - "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100" + "raw": "{{baseUrl}}/events?resource=rooms&type=deleted&actorId=&from=&to=&max=100&serviceType=calling" } }, "status": "Unauthorized" @@ -34324,7 +34409,7 @@ { "name": "Get all customers managed by a partner admin", "request": { - "description": "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default.\n\nThis API can be invoked by Partner Full Admin and Partner Readonly Admin.\nSpecify the `personId` in the `managedBy` parameter in the URI.", + "description": "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default. This does not include customers managed through Customer Groups.\n\nThis API can be invoked by Partner Full Admin and Partner Readonly Admin.\nSpecify the `personId` in the `managedBy` parameter in the URI.", "header": [ { "key": "Accept", @@ -34846,7 +34931,7 @@ { "name": "Get all partner admins assigned to a customer", "request": { - "description": "For a given customer, get all the partner admins with their role details.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter.", + "description": "For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter.", "header": [ { "key": "Accept", @@ -36014,7 +36099,7 @@ { "name": "Unassign partner admin from a customer", "request": { - "description": "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", + "description": "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user. If a partner admin is also managing the customer organization through a Customer Group, they will continue to have access.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.", "header": [], "method": "DELETE", "url": { @@ -40707,7 +40792,7 @@ { "name": "List People", "request": { - "description": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + "description": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", "header": [ { "key": "Accept", @@ -74843,7 +74928,7 @@ }, "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"userName\": \"\",\n \"userType\": \"room\",\n \"title\": \"\",\n \"active\": \"\",\n \"roles\": [\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\",\n \"display\": \"\"\n }\n ],\n \"preferredLanguage\": \"\",\n \"locale\": \"\",\n \"timezone\": \"\",\n \"profileUrl\": \"\",\n \"externalId\": \"\",\n \"displayName\": \"\",\n \"nickName\": \"\",\n \"name\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"middleName\": \"\",\n \"honorificPrefix\": \"\",\n \"honorificSuffix\": \"\"\n },\n \"phoneNumbers\": [\n {\n \"value\": \"\",\n \"type\": \"other\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"\",\n \"type\": \"resizable\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"thumbnail\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"type\": \"\",\n \"streetAddress\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n {\n \"type\": \"\",\n \"streetAddress\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n }\n ],\n \"emails\": [\n {\n \"value\": \"\",\n \"type\": \"home\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"room\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\": {\n \"costCenter\": \"\",\n \"organization\": \"\",\n \"division\": \"\",\n \"department\": \"\",\n \"employeeNumber\": \"\",\n \"manager\": {\n \"value\": \"\"\n }\n },\n \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\": {\n \"accountStatus\": \"transient\",\n \"sipAddresses\": [\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"display\": \"\",\n \"primary\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"enterprise\",\n \"display\": \"\",\n \"primary\": \"\"\n }\n ],\n \"managedOrgs\": [\n {\n \"orgId\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"role\": \"\"\n }\n ],\n \"managedGroups\": [\n {\n \"orgId\": \"\",\n \"groupId\": \"\",\n \"role\": \"\"\n },\n {\n \"orgId\": \"\",\n \"groupId\": \"\",\n \"role\": \"\"\n }\n ],\n \"extensionAttribute*\": [\n \"\",\n \"\"\n ],\n \"externalAttribute*\": [\n {\n \"source\": \"\",\n \"value\": \"\"\n },\n {\n \"source\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, - "description": "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n\u2022 urn:ietf:params:scim:schemas:core:2.0:User\n\n\u2022 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n\u2022 urn:scim:schemas:extension:cisco:webexidentity:2.0:User\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.", + "description": "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n\u2022 urn:ietf:params:scim:schemas:core:2.0:User\n\n\u2022 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n\u2022 urn:scim:schemas:extension:cisco:webexidentity:2.0:User\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", "header": [ { "key": "Content-Type", @@ -78633,7 +78718,7 @@ }, "raw": "{\n \"schemas\": [\n \"\",\n \"\"\n ],\n \"Operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, - "description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`.\nThe result of the add operation depends upon the target `path` reference locations:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`.\nThe operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will return failure as HTTP status code 400 and a `scimType` error code of \"noTarget\".\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute's sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.", + "description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`.\nThe result of the add operation depends upon the target `path` reference locations:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`.\nThe operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will return failure as HTTP status code 400 and a `scimType` error code of \"noTarget\".\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute's sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin", "header": [ { "key": "Content-Type", diff --git a/codegen/postman/Webex Cloud Calling.postman_collection.json b/codegen/postman/Webex Cloud Calling.postman_collection.json index 71ff9e8..07a5977 100644 --- a/codegen/postman/Webex Cloud Calling.postman_collection.json +++ b/codegen/postman/Webex Cloud Calling.postman_collection.json @@ -20690,7 +20690,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination.", "header": [ @@ -20733,7 +20733,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20772,7 +20772,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20811,7 +20811,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20850,7 +20850,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20889,7 +20889,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20928,7 +20928,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -20967,7 +20967,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21011,7 +21011,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21054,7 +21054,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21093,7 +21093,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21132,7 +21132,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21171,7 +21171,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21210,7 +21210,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21249,7 +21249,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21288,7 +21288,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -21327,7 +21327,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28028,7 +28028,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command.", "header": [ @@ -28071,7 +28071,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28110,7 +28110,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28149,7 +28149,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28188,7 +28188,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28227,7 +28227,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28266,7 +28266,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28305,7 +28305,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28344,7 +28344,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28383,7 +28383,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28422,7 +28422,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28461,7 +28461,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28500,7 +28500,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28539,7 +28539,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28578,7 +28578,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28622,7 +28622,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -28665,7 +28665,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32661,7 +32661,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user's call pickup group. When target is present, the API pickups an incoming call from the specified target user.", "header": [ @@ -32704,7 +32704,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32743,7 +32743,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32782,7 +32782,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32821,7 +32821,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32860,7 +32860,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32899,7 +32899,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32938,7 +32938,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -32977,7 +32977,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33016,7 +33016,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33055,7 +33055,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33094,7 +33094,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33133,7 +33133,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33172,7 +33172,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33216,7 +33216,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33259,7 +33259,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33298,7 +33298,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33334,7 +33334,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Barge-in on another user's answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command.", "header": [ @@ -33377,7 +33377,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33416,7 +33416,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33455,7 +33455,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33494,7 +33494,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33538,7 +33538,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33581,7 +33581,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33620,7 +33620,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33659,7 +33659,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33698,7 +33698,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33737,7 +33737,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33776,7 +33776,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33815,7 +33815,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33854,7 +33854,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33893,7 +33893,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33932,7 +33932,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -33971,7 +33971,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -35710,7 +35710,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "description": "Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination.", "header": [ @@ -35769,7 +35769,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -35824,7 +35824,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -35879,7 +35879,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -35934,7 +35934,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -35989,7 +35989,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36044,7 +36044,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36099,7 +36099,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36154,7 +36154,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36209,7 +36209,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36264,7 +36264,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36319,7 +36319,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36374,7 +36374,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36429,7 +36429,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36484,7 +36484,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36544,7 +36544,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -36603,7 +36603,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\"\n}" }, "header": [ { @@ -84386,7 +84386,7 @@ }, { "_postman_previewlanguage": "json", - "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"\",\n \"counts\": {\n \"routingPrefixUpdated\": \"\",\n \"routingPrefixFailed\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"\",\n \"counts\": {\n \"routingPrefixUpdated\": \"\",\n \"routingPrefixFailed\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n }\n ],\n \"latestExecutionExitCode\": \"UNKNOWN\"\n }\n]", + "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"\",\n \"counts\": {\n \"routingPrefixUpdated\": \"\",\n \"routingPrefixFailed\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n }\n ],\n \"latestExecutionExitCode\": \"COMPLETED_WITH_ERRORS\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"trackingId\": \"\",\n \"sourceUserId\": \"\",\n \"sourceCustomerId\": \"\",\n \"targetCustomerId\": \"\",\n \"instanceId\": \"\",\n \"latestExecutionStatus\": \"\",\n \"counts\": {\n \"routingPrefixUpdated\": \"\",\n \"routingPrefixFailed\": \"\"\n },\n \"jobExecutionStatus\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"createdTime\": \"\",\n \"stepExecutionStatuses\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"lastUpdated\": \"\",\n \"statusMessage\": \"\",\n \"exitCode\": \"\",\n \"name\": \"\",\n \"timeElapsed\": \"\"\n }\n ]\n }\n ],\n \"latestExecutionExitCode\": \"FAILED\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -87062,7 +87062,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"locationInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\",\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"effectiveLevel\": \"LOCATION_MEMBER_NUMBER\"\n },\n \"locationMemberInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\",\n \"phoneNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"memberId\": \"\",\n \"memberType\": \"PEOPLE\",\n \"effectiveLevel\": \"LOCATION_NUMBER\"\n },\n \"selected\": \"LOCATION_NUMBER\"\n}", + "body": "{\n \"locationInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\",\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"effectiveLevel\": \"LOCATION_MEMBER_NUMBER\"\n },\n \"locationMemberInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\",\n \"phoneNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"memberId\": \"\",\n \"memberType\": \"PEOPLE\",\n \"effectiveLevel\": \"LOCATION_NUMBER\"\n },\n \"selected\": \"LOCATION_NUMBER\",\n \"elinExpiryTimeMinutes\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -87643,7 +87643,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "description": "Update details for a location emergency callback number.\n\n* Updating a location callback number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -87699,7 +87699,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -87754,7 +87754,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -87809,7 +87809,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -87864,7 +87864,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -87919,7 +87919,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -87974,7 +87974,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88029,7 +88029,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88084,7 +88084,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88139,7 +88139,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88194,7 +88194,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88249,7 +88249,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88304,7 +88304,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88359,7 +88359,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88414,7 +88414,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88469,7 +88469,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -88524,7 +88524,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"LOCATION_NUMBER\",\n \"locationMemberId\": \"\",\n \"elinExpiryTimeMinutes\": \"\"\n}" }, "header": [ { @@ -145951,7 +145951,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "response": [ @@ -145974,7 +145981,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Not Found" @@ -145998,7 +146012,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Unauthorized" @@ -146022,7 +146043,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Too Many Requests" @@ -146046,7 +146074,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Gateway Timeout" @@ -146070,7 +146105,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Locked (WebDAV) (RFC 4918)" @@ -146094,7 +146136,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Bad Gateway" @@ -146118,7 +146167,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Unsupported Media Type" @@ -146142,7 +146198,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Method Not Allowed" @@ -146176,7 +146239,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "OK" @@ -146200,7 +146270,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Gone" @@ -146224,7 +146301,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Internal Server Error" @@ -146248,7 +146332,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Bad Request" @@ -146272,7 +146363,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Conflict" @@ -146296,7 +146394,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Forbidden" @@ -146320,7 +146425,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Precondition Required" @@ -146344,7 +146456,14 @@ "config", "announcementLanguages" ], - "raw": "{{baseUrl}}/telephony/config/announcementLanguages" + "query": [ + { + "description": "Filter languages by TTS support.", + "key": "ttsLanguage", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/announcementLanguages?ttsLanguage=" } }, "status": "Service Unavailable" @@ -164321,7 +164440,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"ownerId\": \"\",\n \"ownerType\": \"\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"storageRegion\": \"\",\n \"serviceType\": \"\",\n \"version\": \"\",\n \"serviceData\": {\n \"callRecordingId\": \"\",\n \"locationId\": \"\",\n \"callSessionId\": \"\",\n \"personality\": \"\",\n \"callingParty\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"calledParty\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"callId\": \"\",\n \"session\": {\n \"startTime\": \"\",\n \"stopTime\": \"\"\n },\n \"recordingType\": \"\",\n \"answererInfo\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"recordingActions\": [\n {\n \"action\": \"\",\n \"time\": \"\"\n },\n {\n \"action\": \"\",\n \"time\": \"\"\n }\n ],\n \"callActivity\": [\n {\n \"timeStamp\": \"\",\n \"mediaStreams\": [\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n },\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n }\n ],\n \"participants\": [\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n },\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n }\n ],\n \"announcementData\": {\n \"announcementFilename\": \"\",\n \"announcementTimestamp\": \"\",\n \"announcementParticipants\": [\n \"\",\n \"\"\n ],\n \"announcementType\": \"\"\n }\n },\n {\n \"timeStamp\": \"\",\n \"mediaStreams\": [\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n },\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n }\n ],\n \"participants\": [\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n },\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n }\n ],\n \"announcementData\": {\n \"announcementFilename\": \"\",\n \"announcementTimestamp\": \"\",\n \"announcementParticipants\": [\n \"\",\n \"\"\n ],\n \"announcementType\": \"\"\n }\n }\n ]\n }\n}", + "body": "{\n \"id\": \"\",\n \"orgId\": \"\",\n \"ownerId\": \"\",\n \"ownerType\": \"\",\n \"ownerName\": \"\",\n \"ownerEmail\": \"\",\n \"storageRegion\": \"\",\n \"serviceType\": \"\",\n \"version\": \"\",\n \"serviceData\": {\n \"callRecordingId\": \"\",\n \"locationId\": \"\",\n \"callSessionId\": \"\",\n \"personality\": \"\",\n \"callingParty\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"calledParty\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"callId\": \"\",\n \"session\": {\n \"startTime\": \"\",\n \"stopTime\": \"\"\n },\n \"recordingType\": \"\",\n \"answererInfo\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"recordingActions\": [\n {\n \"action\": \"\",\n \"time\": \"\"\n },\n {\n \"action\": \"\",\n \"time\": \"\"\n }\n ],\n \"callActivity\": [\n {\n \"timeStamp\": \"\",\n \"mediaStreams\": [\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n },\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n }\n ],\n \"participants\": [\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n },\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n }\n ],\n \"announcementData\": {\n \"announcementFilename\": \"\",\n \"announcementTimestamp\": \"\",\n \"announcementParticipants\": [\n \"\",\n \"\"\n ],\n \"announcementType\": \"\"\n }\n },\n {\n \"timeStamp\": \"\",\n \"mediaStreams\": [\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n },\n {\n \"streamId\": \"\",\n \"mode\": \"\",\n \"mLineIndex\": \"\"\n }\n ],\n \"participants\": [\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n },\n {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"aor\": \"\",\n \"send\": \"\"\n }\n ],\n \"announcementData\": {\n \"announcementFilename\": \"\",\n \"announcementTimestamp\": \"\",\n \"announcementParticipants\": [\n \"\",\n \"\"\n ],\n \"announcementType\": \"\"\n }\n }\n ],\n \"managedBy\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n },\n \"connectedParty\": {\n \"actor\": {\n \"type\": \"\",\n \"id\": \"\"\n },\n \"number\": \"\"\n }\n }\n}", "code": 200, "cookie": [], "header": [ @@ -175019,7 +175138,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"PRIMARY\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PLACE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"activated\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"modelType\": \"APPLICATION\",\n \"mac\": \"\",\n \"ipAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"HOTDESKING_GUEST\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"deactivated\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"modelType\": \"APPLICATION\",\n \"mac\": \"\",\n \"ipAddress\": \"\"\n }\n ],\n \"maxDeviceCount\": \"\"\n}", + "body": "{\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"PRIMARY\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PLACE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"activated\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"modelType\": \"APPLICATION\",\n \"mac\": \"\",\n \"ipAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"HOTDESKING_GUEST\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"deactivated\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"modelType\": \"APPLICATION\",\n \"mac\": \"\",\n \"ipAddress\": \"\"\n }\n ],\n \"maxDeviceCount\": \"\",\n \"maxOwnedDeviceCount\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -177113,7 +177232,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PLACE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"DEACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\",\n \"ipAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"PRIMARY\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"DEACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\",\n \"ipAddress\": \"\"\n }\n ],\n \"maxDeviceCount\": \"\"\n}", + "body": "{\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PLACE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"DEACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\",\n \"ipAddress\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"PRIMARY\",\n \"hoteling\": {\n \"enabled\": \"\",\n \"limitGuestUse\": \"\",\n \"guestHoursLimit\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"DEACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\",\n \"ipAddress\": \"\"\n }\n ],\n \"maxDeviceCount\": \"\",\n \"maxOwnedDeviceCount\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -200726,8 +200845,15 @@ { "name": "Upload a Device Background Image", "request": { + "body": { + "mode": "params" + }, "description": "Configure a device's background image by uploading an image with file format, `.jpeg` or `.png`, encoded image file. Maximum image file size allowed to upload is 625 KB.\n\nThe request must be a multipart/form-data request rather than JSON, using the image/jpeg or image/png content-type.\n\nWebex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.\n\nUploading a device background image requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.", "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, { "key": "Accept", "value": "application/json" @@ -200773,7 +200899,15 @@ "header": [], "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -200814,7 +200948,15 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -200855,7 +200997,15 @@ "header": [], "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -200896,7 +201046,15 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -200937,7 +201095,15 @@ "header": [], "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -200978,7 +201144,15 @@ "header": [], "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201019,7 +201193,15 @@ "header": [], "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201060,7 +201242,15 @@ "header": [], "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201101,7 +201291,15 @@ "header": [], "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201142,7 +201340,15 @@ "header": [], "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201188,7 +201394,14 @@ ], "name": "Created", "originalRequest": { + "body": { + "mode": "params" + }, "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, { "key": "Accept", "value": "application/json" @@ -201234,7 +201447,15 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201275,7 +201496,15 @@ "header": [], "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201316,7 +201545,15 @@ "header": [], "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201357,7 +201594,15 @@ "header": [], "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -201398,7 +201643,15 @@ "header": [], "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [], + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], "method": "POST", "url": { "host": [ @@ -206660,7 +206913,7 @@ }, "raw": "{\n \"mac\": \"\",\n \"model\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"password\": \"\"\n}" }, - "description": "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + "description": "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone configuration from [here](/docs/api/v1/beta-device-call-settings-with-third-party-device-support/get-third-party-device).\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", "header": [ { "key": "Content-Type", @@ -209531,7 +209784,7 @@ }, "raw": "{\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"model\": \"\"\n}" }, - "description": "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
", + "description": "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace calling type to `freeCalling`.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* If no `model` is supplied, the `code` returned will only be accepted on RoomOS devices.\n\n* If your device is a phone, you must provide the `model` as a field. You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n
Adding a device to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.

When adding devices to a Webex Calling Professional licensed person or workspace, wait for each API call to finish before starting the next. This prevents race conditions that can cause errors when assigning primary versus secondary device status.
", "header": [ { "key": "Content-Type", @@ -223686,7 +223939,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"selected\": \"LOCATION_MEMBER_NUMBER\",\n \"directLineInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"DIRECT_LINE\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationECBNInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationMemberInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"memberId\": \"\",\n \"memberType\": \"PEOPLE\",\n \"effectiveLevel\": \"LOCATION_MEMBER_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"defaultInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"INVALID\"\n }\n}", + "body": "{\n \"selected\": \"LOCATION_MEMBER_NUMBER\",\n \"directLineInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"DIRECT_LINE\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationECBNInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationMemberInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"memberId\": \"\",\n \"memberType\": \"PEOPLE\",\n \"effectiveLevel\": \"LOCATION_MEMBER_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"defaultInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"INVALID\"\n },\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -223902,7 +224155,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "description": "Update a person's emergency callback number settings.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nTo update an emergency callback number requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -223957,7 +224210,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224011,7 +224264,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224065,7 +224318,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224119,7 +224372,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224173,7 +224426,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224227,7 +224480,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224281,7 +224534,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224335,7 +224588,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224389,7 +224642,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224443,7 +224696,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224497,7 +224750,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224551,7 +224804,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224605,7 +224858,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224659,7 +224912,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224713,7 +224966,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -224767,7 +225020,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\",\n \"elinForWebexAppEnabled\": \"\"\n}" }, "header": [ { @@ -225620,7 +225873,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"selected\": \"DIRECT_LINE\",\n \"directLineInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_ECBN\",\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\"\n },\n \"locationECBNInfo\": {\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationMemberInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"memberId\": \"\",\n \"effectiveLevel\": \"NONE\",\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\",\n \"memberType\": \"PEOPLE\"\n },\n \"defaultInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\"\n }\n}", + "body": "{\n \"selected\": \"DIRECT_LINE\",\n \"directLineInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_ECBN\",\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\"\n },\n \"locationECBNInfo\": {\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"phoneNumber\": \"\",\n \"effectiveLevel\": \"LOCATION_NUMBER\",\n \"effectiveValue\": \"\",\n \"quality\": \"NOT_RECOMMENDED\"\n },\n \"locationMemberInfo\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"memberId\": \"\",\n \"effectiveLevel\": \"NONE\",\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\",\n \"memberType\": \"PEOPLE\"\n },\n \"defaultInfo\": {\n \"effectiveValue\": \"\",\n \"quality\": \"RECOMMENDED\"\n },\n \"elinEnabled\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -226187,7 +226440,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "description": "Update the emergency callback number settings for a workspace.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nTo update an emergency callback number requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -226242,7 +226495,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226296,7 +226549,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226350,7 +226603,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226404,7 +226657,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226458,7 +226711,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226512,7 +226765,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226566,7 +226819,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226620,7 +226873,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226674,7 +226927,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226728,7 +226981,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226782,7 +227035,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226836,7 +227089,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226890,7 +227143,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226944,7 +227197,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -226998,7 +227251,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -227052,7 +227305,7 @@ "language": "json" } }, - "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\"\n}" + "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"locationMemberId\": \"\",\n \"elinEnabled\": \"\"\n}" }, "header": [ { @@ -236556,9 +236809,16 @@ "name": "Upload a binary announcement greeting at organization level", "request": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, - "description": "Upload a binary file to the announcement repository at an organization level.\n\nAn admin can upload a file at an organization level. This file will be uploaded to the announcement repository.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\n**Note:** The `name` parameter is required as a form field and should contain the announcement file name (e.g., \"greeting.wav\"). Refer to the example below for the complete request structure.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write` .", + "description": "Upload a binary file to the announcement repository at an organization level.\n\nAn admin can upload a file at an organization level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -236599,7 +236859,8 @@ "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236638,7 +236899,8 @@ "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236677,7 +236939,8 @@ "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236716,7 +236979,8 @@ "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236755,7 +237019,8 @@ "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236794,7 +237059,8 @@ "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236833,7 +237099,8 @@ "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236872,7 +237139,8 @@ "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236911,7 +237179,8 @@ "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236950,7 +237219,8 @@ "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -236989,7 +237259,8 @@ "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -237033,7 +237304,14 @@ "name": "Created", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -237076,7 +237354,8 @@ "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -237115,7 +237394,8 @@ "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -237154,7 +237434,8 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -237193,7 +237474,8 @@ "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -238998,7 +239280,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileSize\": \"\",\n \"mediaFileType\": \"\",\n \"lastUpdated\": \"\",\n \"featureReferenceCount\": \"\",\n \"fileName\": \"\",\n \"featureReferences\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n }\n ],\n \"playlists\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileSize\": \"\",\n \"mediaFileType\": \"\",\n \"lastUpdated\": \"\",\n \"featureReferenceCount\": \"\",\n \"fileName\": \"\",\n \"featureReferences\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n }\n ],\n \"playlists\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"isTextToSpeech\": \"\",\n \"voice\": \"\",\n \"language\": \"\",\n \"text\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -239087,8 +239369,23 @@ { "name": "Modify a binary announcement greeting at organization level", "request": { - "description": "Modify an existing announcement greeting at a organization level.\n\nAn admin can upload a file or modify an existing file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "description": "Modify an existing announcement greeting at an organization level.\n\nAn admin can upload a file or modify an existing file at an organization level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239126,7 +239423,22 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239164,7 +239476,22 @@ "header": [], "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239202,7 +239529,22 @@ "header": [], "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239240,7 +239582,22 @@ "header": [], "name": "No Content", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239278,7 +239635,22 @@ "header": [], "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239316,7 +239688,22 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239354,7 +239741,22 @@ "header": [], "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239392,7 +239794,22 @@ "header": [], "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239430,7 +239847,22 @@ "header": [], "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239468,7 +239900,22 @@ "header": [], "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239506,7 +239953,22 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239544,7 +240006,22 @@ "header": [], "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239582,7 +240059,22 @@ "header": [], "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239620,7 +240112,22 @@ "header": [], "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239658,7 +240165,22 @@ "header": [], "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239696,7 +240218,22 @@ "header": [], "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -239732,9 +240269,16 @@ "name": "Upload a binary announcement greeting at the location level", "request": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, - "description": "Upload a binary file to the announcement repository at a location level.\n\nAn admin can upload a file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\n**Note:** The `name` parameter is required as a form field and should contain the announcement file name (e.g., \"greeting.wav\"). Refer to the example below for the complete request structure.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write` .", + "description": "Upload a binary file to the announcement repository at a location level.\n\nAn admin can upload a file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -239784,7 +240328,8 @@ "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -239831,7 +240376,8 @@ "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -239878,7 +240424,8 @@ "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -239925,7 +240472,8 @@ "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -239977,7 +240525,14 @@ "name": "Created", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240028,7 +240583,8 @@ "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240075,7 +240631,8 @@ "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240122,7 +240679,8 @@ "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240169,7 +240727,8 @@ "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240216,7 +240775,8 @@ "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240263,7 +240823,8 @@ "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240310,7 +240871,8 @@ "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240357,7 +240919,8 @@ "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240404,7 +240967,8 @@ "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240451,7 +241015,8 @@ "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -240498,7 +241063,8 @@ "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" }, "header": [ { @@ -242422,7 +242988,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileSize\": \"\",\n \"mediaFileType\": \"\",\n \"lastUpdated\": \"\",\n \"featureReferenceCount\": \"\",\n \"fileName\": \"\",\n \"featureReferences\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n }\n ]\n}", + "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileSize\": \"\",\n \"mediaFileType\": \"\",\n \"lastUpdated\": \"\",\n \"featureReferenceCount\": \"\",\n \"fileName\": \"\",\n \"featureReferences\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"locationId\": \"\",\n \"locationName\": \"\"\n }\n ],\n \"isTextToSpeech\": \"\",\n \"voice\": \"\",\n \"language\": \"\",\n \"text\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -242743,8 +243309,23 @@ { "name": "Modify a binary announcement greeting at location level", "request": { - "description": "Modify an existing announcement greeting at a location level.\n\nAn admin can upload a file or modify an existing file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "description": "Modify an existing announcement greeting at a location level.\n\nAn admin can upload a file or modify an existing file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -242789,7 +243370,22 @@ "header": [], "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -242833,7 +243429,22 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -242877,7 +243488,22 @@ "header": [], "name": "No Content", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -242921,7 +243547,22 @@ "header": [], "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -242965,51 +243606,81 @@ "header": [], "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "telephony", - "config", - "locations", - ":locationId", - "announcements", - ":announcementId" - ], - "query": [ - { - "description": "Modify an announcement for location in this organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/:announcementId?orgId=", - "variable": [ - { - "description": "Unique identifier of a location where an announcement is being created.", - "key": "locationId" - }, - { - "description": "Unique identifier of an announcement.", - "key": "announcementId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Service Unavailable" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, - "cookie": [], - "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", - "originalRequest": { - "header": [], + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "announcements", + ":announcementId" + ], + "query": [ + { + "description": "Modify an announcement for location in this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/:announcementId?orgId=", + "variable": [ + { + "description": "Unique identifier of a location where an announcement is being created.", + "key": "locationId" + }, + { + "description": "Unique identifier of an announcement.", + "key": "announcementId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243053,7 +243724,22 @@ "header": [], "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243097,7 +243783,22 @@ "header": [], "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243141,7 +243842,22 @@ "header": [], "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243185,7 +243901,22 @@ "header": [], "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243229,7 +243960,22 @@ "header": [], "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243273,7 +244019,22 @@ "header": [], "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243317,7 +244078,22 @@ "header": [], "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243361,7 +244137,22 @@ "header": [], "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243405,7 +244196,22 @@ "header": [], "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243449,7 +244255,22 @@ "header": [], "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"fileUri\": \"\",\n \"fileName\": \"\",\n \"isTextToSpeech\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "PUT", "url": { "host": [ @@ -243486,6 +244307,1964 @@ "status": "Precondition Required" } ] + }, + { + "name": "Generate a Text-to-Speech Prompt", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "description": "Generate a text-to-speech prompt from the provided text, voice, and language.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\"\n}", + "code": 202, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"voice\": \"\",\n \"text\": \"\",\n \"languageCode\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "actions", + "generate", + "invoke" + ], + "query": [ + { + "description": "Generate text-to-speech for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke?orgId=" + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Get Text-to-Speech Usage", + "request": { + "description": "Retrieve text-to-speech usage information, including the number of API calls made, the maximum allowed within the time window, and the timestamp indicating when the usage will reset.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"noOfApiCalls\": \"\",\n \"maxAllowedApiCalls\": \"\",\n \"usageResetTimestamp\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "usage" + ], + "query": [ + { + "description": "Get text-to-speech usage for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/usage?orgId=" + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Get Text-to-Speech Generation Status", + "request": { + "description": "Get the status of a text-to-speech generation request by its ID. If the status is SUCCESS, the response includes `promptUrl`, `kmsKeyUri`, and `fileUri` to preview or use the audio prompt.\n\nTo preview the audio prompt:\n\n1. Download the KMS key - use the Webex Node.js SDK and provide `kmsKeyUri` to download the key from KMS.\n\n2. Download the encrypted audio - The encrypted audio file content is stored in cloud and can be retrieved using `promptURL`.\n\n3. Decrypt the audio content - Use the jose library to decrypt the content downloaded from `promptUrl` using the downloaded key.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"text\": \"\",\n \"voice\": \"\",\n \"languageCode\": \"\",\n \"promptUrl\": \"\",\n \"kmsKeyUri\": \"\",\n \"fileUri\": \"\",\n \"errorMessage\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + ":ttsId" + ], + "query": [ + { + "description": "Get text-to-speech status for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId?orgId=", + "variable": [ + { + "description": "Unique identifier of the text-to-speech generation request.", + "key": "ttsId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + } + ] + }, + { + "name": "List Text-to-Speech Voices", + "request": { + "description": "Fetch a list of available text-to-speech voices. Use the returned voice ID in the generation request.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"voices\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "textToSpeech", + "voices" + ], + "query": [ + { + "description": "List text-to-speech voices supported for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/textToSpeech/voices?orgId=" + } + }, + "status": "Unauthorized" + } + ] } ], "name": "Features: Announcement Repository" @@ -244468,7 +247247,7 @@ { "name": "Get Details for an Auto Attendant", "request": { - "description": "Retrieve an Auto Attendant details.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve an Auto Attendant details.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -245240,7 +248019,7 @@ }, "raw": "{\n \"name\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"alternateNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_LONG_SHORT\",\n \"tollFreeNumber\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_SHORT_LONG\",\n \"tollFreeNumber\": \"\"\n }\n ],\n \"languageCode\": \"\",\n \"businessSchedule\": \"\",\n \"holidaySchedule\": \"\",\n \"extensionDialing\": \"ENTERPRISE\",\n \"nameDialing\": \"ENTERPRISE\",\n \"timeZone\": \"\",\n \"businessHoursMenu\": {\n \"greeting\": \"CUSTOM\",\n \"extensionEnabled\": \"\",\n \"keyConfigurations\": {\n \"key\": \"1\",\n \"action\": \"NAME_DIALING\",\n \"description\": \"\",\n \"value\": \"\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n }\n },\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n },\n \"callTreatment\": {\n \"retryAttemptForNoInput\": \"NO_REPEAT\",\n \"noInputTimer\": \"\",\n \"actionToBePerformed\": {\n \"action\": \"TRANSFER_TO_MAILBOX\",\n \"greeting\": \"DEFAULT\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n },\n \"transferCallTo\": \"\"\n }\n }\n },\n \"afterHoursMenu\": {\n \"greeting\": \"CUSTOM\",\n \"extensionEnabled\": \"\",\n \"keyConfigurations\": {\n \"key\": \"3\",\n \"action\": \"TRANSFER_TO_OPERATOR\",\n \"description\": \"\",\n \"value\": \"\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n }\n },\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n },\n \"callTreatment\": {\n \"retryAttemptForNoInput\": \"TWO_TIMES\",\n \"noInputTimer\": \"\",\n \"actionToBePerformed\": {\n \"action\": \"TRANSFER_WITHOUT_PROMPT\",\n \"greeting\": \"CUSTOM\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n },\n \"transferCallTo\": \"\"\n }\n }\n },\n \"directLineCallerIdName\": {\n \"selection\": \"DISPLAY_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Update the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nUpdating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Update the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nUpdating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -246989,7 +249768,7 @@ }, "raw": "{\n \"name\": \"\",\n \"businessSchedule\": \"\",\n \"businessHoursMenu\": {\n \"greeting\": \"DEFAULT\",\n \"extensionEnabled\": \"\",\n \"keyConfigurations\": {\n \"key\": \"4\",\n \"action\": \"EXIT\",\n \"description\": \"\",\n \"value\": \"\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n }\n },\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n },\n \"callTreatment\": {\n \"retryAttemptForNoInput\": \"NO_REPEAT\",\n \"noInputTimer\": \"\",\n \"actionToBePerformed\": {\n \"action\": \"TRANSFER_TO_MAILBOX\",\n \"greeting\": \"CUSTOM\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n },\n \"transferCallTo\": \"\"\n }\n }\n },\n \"afterHoursMenu\": {\n \"greeting\": \"CUSTOM\",\n \"extensionEnabled\": \"\",\n \"keyConfigurations\": {\n \"key\": \"7\",\n \"action\": \"EXIT\",\n \"description\": \"\",\n \"value\": \"\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n }\n },\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"LOCATION\"\n },\n \"callTreatment\": {\n \"retryAttemptForNoInput\": \"THREE_TIMES\",\n \"noInputTimer\": \"\",\n \"actionToBePerformed\": {\n \"action\": \"DISCONNECT\",\n \"greeting\": \"DEFAULT\",\n \"audioAnnouncementFile\": {\n \"id\": \"\",\n \"fileName\": \"\",\n \"mediaFileType\": \"WAV\",\n \"level\": \"ORGANIZATION\"\n },\n \"transferCallTo\": \"\"\n }\n }\n },\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"alternateNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_SHORT_LONG\",\n \"tollFreeNumber\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_LONG_SHORT\",\n \"tollFreeNumber\": \"\"\n }\n ],\n \"languageCode\": \"\",\n \"holidaySchedule\": \"\",\n \"extensionDialing\": \"GROUP\",\n \"nameDialing\": \"GROUP\",\n \"timeZone\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Create new Auto Attendant for the given location.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nCreating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Create new Auto Attendant for the given location.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nCreating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -248695,7 +251474,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "description": "Update Call Forwarding settings for the designated Auto Attendant.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -248757,7 +251536,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -248817,7 +251596,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -248877,7 +251656,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -248937,7 +251716,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -248997,7 +251776,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249057,7 +251836,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249117,7 +251896,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249177,7 +251956,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249237,7 +252016,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249297,7 +252076,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249357,7 +252136,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249417,7 +252196,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249477,7 +252256,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249537,7 +252316,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249597,7 +252376,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -249657,7 +252436,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"sendToVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -256712,7 +259491,7 @@ }, "raw": "{}" }, - "description": "Switches the current operating mode of the `Auto Attendant` to the mode as per normal operations.\n\nSwitching operating mode for an `auto attendant` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "description": "Switches the current operating mode of the `Auto Attendant` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for an `auto attendant` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -277983,7 +280762,7 @@ { "item": [ { - "name": "Read the List of Call Queues with Customer Experience Essentials", + "name": "Read the List of Call Queues with Customer Assist", "request": { "description": "List all Call Queues for the organization.\n\nCall queues temporarily hold calls in the cloud, when all agents\nassigned to receive calls from the queue are unavailable. Queued calls are routed to \nan available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach the users assigned to the call queue.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ @@ -278044,7 +280823,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278114,7 +280893,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278185,7 +280964,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278256,7 +281035,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278327,7 +281106,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278398,7 +281177,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278469,7 +281248,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278540,7 +281319,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278611,7 +281390,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278682,7 +281461,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278753,7 +281532,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278824,7 +281603,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278895,7 +281674,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -278966,7 +281745,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -279037,7 +281816,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -279108,7 +281887,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -279198,7 +281977,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" } @@ -279211,7 +281990,7 @@ ] }, { - "name": "Create a Call Queue with Customer Experience Essentials", + "name": "Create a Call Queue with Customer Assist", "request": { "body": { "mode": "raw", @@ -279223,7 +282002,7 @@ }, "raw": "{\n \"name\": \"\",\n \"callPolicies\": {\n \"routingType\": \"SKILL_BASED\",\n \"policy\": \"WEIGHTED\",\n \"callBounce\": {\n \"callBounceEnabled\": \"\",\n \"callBounceMaxRings\": \"\",\n \"agentUnavailableEnabled\": \"\",\n \"alertAgentEnabled\": \"\",\n \"alertAgentMaxSeconds\": \"\",\n \"callBounceOnHoldEnabled\": \"\",\n \"callBounceOnHoldMaxSeconds\": \"\"\n },\n \"distinctiveRing\": {\n \"enabled\": \"\",\n \"ringPattern\": \"SHORT_LONG_SHORT\"\n }\n },\n \"queueSettings\": {\n \"queueSize\": \"\",\n \"overflow\": {\n \"action\": \"PERFORM_BUSY_TREATMENT\",\n \"greeting\": \"CUSTOM\",\n \"sendToVoicemail\": \"\",\n \"transferNumber\": \"\",\n \"overflowAfterWaitEnabled\": \"\",\n \"overflowAfterWaitTime\": \"\",\n \"playOverflowGreetingEnabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"callOfferToneEnabled\": \"\",\n \"resetCallStatisticsEnabled\": \"\",\n \"welcomeMessage\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"alwaysEnabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n }\n ]\n },\n \"waitMessage\": {\n \"waitMode\": \"POSITION\",\n \"enabled\": \"\",\n \"handlingTime\": \"\",\n \"defaultHandlingTime\": \"\",\n \"queuePosition\": \"\",\n \"highVolumeMessageEnabled\": \"\",\n \"estimatedWaitingTime\": \"\",\n \"callbackOptionEnabled\": \"\",\n \"minimumEstimatedCallbackTime\": \"\",\n \"internationalCallbackEnabled\": \"\",\n \"playUpdatedEstimatedWaitMessage\": \"\"\n },\n \"comfortMessage\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"timeBetweenMessages\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n }\n ]\n },\n \"comfortMessageBypass\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"callWaitingAgeThreshold\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"mohMessage\": {\n \"normalSource\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n }\n ],\n \"audioPlaylistId\": \"\"\n },\n \"alternateSource\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ],\n \"audioPlaylistId\": \"\"\n }\n },\n \"whisperMessage\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n }\n ]\n }\n },\n \"agents\": [\n {\n \"id\": \"\",\n \"weight\": \"\",\n \"skillLevel\": \"\"\n },\n {\n \"id\": \"\",\n \"weight\": \"\",\n \"skillLevel\": \"\"\n }\n ],\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"timeZone\": \"\",\n \"callingLineIdPolicy\": \"CUSTOM\",\n \"callingLineIdPhoneNumber\": \"\",\n \"allowAgentJoinEnabled\": \"\",\n \"phoneNumberForOutgoingCallsEnabled\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Create new Call Queues for the given location.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nCreating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Create new Call Queues for the given location.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nCreating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -279253,7 +282032,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279312,7 +282091,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279371,7 +282150,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279430,7 +282209,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279489,7 +282268,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279548,7 +282327,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279607,7 +282386,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279666,7 +282445,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279725,7 +282504,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279784,7 +282563,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279852,7 +282631,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279911,7 +282690,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -279970,7 +282749,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -280029,7 +282808,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -280088,7 +282867,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -280147,7 +282926,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -280206,7 +282985,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials call queue, when `true`. This requires Customer Experience Essentials licensed agents.", + "description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents.", "key": "hasCxEssentials", "value": "" } @@ -280972,9 +283751,9 @@ ] }, { - "name": "Get Details for a Call Queue with Customer Experience Essentials", + "name": "Get Details for a Call Queue with Customer Assist", "request": { - "description": "Retrieve Call Queue details.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nRetrieving call queue details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve Call Queue details.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call queue.\n\nRetrieving call queue details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -281001,7 +283780,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281051,7 +283830,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281100,7 +283879,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281149,7 +283928,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281198,7 +283977,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281247,7 +284026,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281296,7 +284075,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281345,7 +284124,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281394,7 +284173,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281443,7 +284222,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281502,7 +284281,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281551,7 +284330,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281600,7 +284379,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281649,7 +284428,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281698,7 +284477,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281747,7 +284526,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281796,7 +284575,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a call queue with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -281831,7 +284610,7 @@ }, "raw": "{\n \"queueSettings\": {\n \"queueSize\": \"\",\n \"overflow\": {\n \"action\": \"TRANSFER_TO_PHONE_NUMBER\",\n \"greeting\": \"DEFAULT\",\n \"sendToVoicemail\": \"\",\n \"transferNumber\": \"\",\n \"overflowAfterWaitEnabled\": \"\",\n \"overflowAfterWaitTime\": \"\",\n \"playOverflowGreetingEnabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"callOfferToneEnabled\": \"\",\n \"resetCallStatisticsEnabled\": \"\",\n \"welcomeMessage\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"alwaysEnabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"waitMessage\": {\n \"waitMode\": \"POSITION\",\n \"enabled\": \"\",\n \"handlingTime\": \"\",\n \"defaultHandlingTime\": \"\",\n \"queuePosition\": \"\",\n \"highVolumeMessageEnabled\": \"\",\n \"estimatedWaitingTime\": \"\",\n \"callbackOptionEnabled\": \"\",\n \"minimumEstimatedCallbackTime\": \"\",\n \"internationalCallbackEnabled\": \"\",\n \"playUpdatedEstimatedWaitMessage\": \"\"\n },\n \"comfortMessage\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"timeBetweenMessages\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"comfortMessageBypass\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"callWaitingAgeThreshold\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ]\n },\n \"mohMessage\": {\n \"normalSource\": {\n \"greeting\": \"DEFAULT\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"LOCATION\"\n }\n ],\n \"audioPlaylistId\": \"\"\n },\n \"alternateSource\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ORGANIZATION\"\n }\n ],\n \"audioPlaylistId\": \"\"\n }\n },\n \"whisperMessage\": {\n \"greeting\": \"CUSTOM\",\n \"enabled\": \"\",\n \"audioAnnouncementFiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"mediaFileType\": \"\",\n \"level\": \"ENTITY\"\n }\n ]\n }\n },\n \"enabled\": \"\",\n \"name\": \"\",\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"timeZone\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"alternateNumberSettings\": {\n \"distinctiveRingEnabled\": \"\",\n \"alternateNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_SHORT_LONG\"\n },\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_LONG_SHORT\"\n }\n ]\n },\n \"callPolicies\": {\n \"routingType\": \"SKILL_BASED\",\n \"policy\": \"WEIGHTED\",\n \"callBounce\": {\n \"callBounceEnabled\": \"\",\n \"callBounceMaxRings\": \"\",\n \"agentUnavailableEnabled\": \"\",\n \"alertAgentEnabled\": \"\",\n \"alertAgentMaxSeconds\": \"\",\n \"callBounceOnHoldEnabled\": \"\",\n \"callBounceOnHoldMaxSeconds\": \"\"\n },\n \"distinctiveRing\": {\n \"enabled\": \"\",\n \"ringPattern\": \"NORMAL\"\n }\n },\n \"callingLineIdPolicy\": \"CUSTOM\",\n \"callingLineIdPhoneNumber\": \"\",\n \"allowCallWaitingForAgentsEnabled\": \"\",\n \"agents\": [\n {\n \"id\": \"\",\n \"weight\": \"\",\n \"skillLevel\": \"\",\n \"joinEnabled\": \"\"\n },\n {\n \"id\": \"\",\n \"weight\": \"\",\n \"skillLevel\": \"\",\n \"joinEnabled\": \"\"\n }\n ],\n \"allowAgentJoinEnabled\": \"\",\n \"phoneNumberForOutgoingCallsEnabled\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Update the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users assigned to the call queue.\n\nUpdating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Update the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users assigned to the call queue.\n\nUpdating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -285222,7 +288001,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "description": "Update Call Forwarding settings for the designated Call Queue.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -285284,7 +288063,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285344,7 +288123,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285404,7 +288183,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285464,7 +288243,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285524,7 +288303,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285584,7 +288363,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285644,7 +288423,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285704,7 +288483,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285764,7 +288543,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285824,7 +288603,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285884,7 +288663,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -285944,7 +288723,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -286004,7 +288783,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -286064,7 +288843,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -286124,7 +288903,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -286184,7 +288963,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -294539,7 +297318,7 @@ ] }, { - "name": "Update a Call Queue Forced Forward service", + "name": "Update a Call Queue Forced Forward Service", "request": { "body": { "mode": "raw", @@ -296337,7 +299116,7 @@ ] }, { - "name": "Update a Call Queue Stranded Calls service", + "name": "Update a Call Queue Stranded Calls Service", "request": { "body": { "mode": "raw", @@ -301502,7 +304281,7 @@ ] }, { - "name": "Get List of Supervisors with Customer Experience Essentials", + "name": "Get List of Supervisors with Customer Assist", "request": { "description": "Get list of supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nRequires a full, location, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ @@ -301553,7 +304332,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301623,7 +304402,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301684,7 +304463,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301745,7 +304524,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301806,7 +304585,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301867,7 +304646,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301928,7 +304707,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -301989,7 +304768,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302050,7 +304829,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302111,7 +304890,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302172,7 +304951,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302233,7 +305012,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302294,7 +305073,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302355,7 +305134,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302416,7 +305195,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302477,7 +305256,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302538,7 +305317,7 @@ "value": "" }, { - "description": "Returns only the list of supervisors with Customer Experience Essentials license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", + "description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -302551,7 +305330,7 @@ ] }, { - "name": "Create a Supervisor with Customer Experience Essentials", + "name": "Create a Supervisor with Customer Assist", "request": { "body": { "mode": "raw", @@ -302591,7 +305370,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302641,7 +305420,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302692,7 +305471,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302743,7 +305522,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302794,7 +305573,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302845,7 +305624,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302896,7 +305675,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302947,7 +305726,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -302998,7 +305777,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303049,7 +305828,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303109,7 +305888,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303160,7 +305939,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303211,7 +305990,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303262,7 +306041,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303313,7 +306092,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303364,7 +306143,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303415,7 +306194,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303466,7 +306245,7 @@ "value": "" }, { - "description": "Creates a Customer Experience Essentials queue supervisor, when `true`. Customer Experience Essentials queue supervisors must have a Customer Experience Essentials license.", + "description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license.", "key": "hasCxEssentials", "value": "" } @@ -303479,7 +306258,7 @@ ] }, { - "name": "Delete Bulk supervisors", + "name": "Delete Bulk Supervisors", "request": { "body": { "mode": "raw", @@ -304258,7 +307037,7 @@ ] }, { - "name": "Delete A Supervisor", + "name": "Delete a Supervisor", "request": { "description": "Deletes the supervisor from an organization.\n\nSupervisors are users who manage agents and who perform functions including monitoring, coaching, and more.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [], @@ -304902,7 +307681,7 @@ ] }, { - "name": "GET Supervisor Detail with Customer Experience Essentials", + "name": "Get Supervisor Detail with Customer Assist", "request": { "description": "Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ @@ -304954,7 +307733,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305022,7 +307801,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305090,7 +307869,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305158,7 +307937,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305226,7 +308005,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305294,7 +308073,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305362,7 +308141,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305430,7 +308209,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305498,7 +308277,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305566,7 +308345,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305634,7 +308413,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305702,7 +308481,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305770,7 +308549,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305838,7 +308617,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305916,7 +308695,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -305984,7 +308763,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306052,7 +308831,7 @@ "value": "" }, { - "description": "Must be set to `true`, to view the details of a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306071,7 +308850,7 @@ ] }, { - "name": "Assign or Unassign Agents to Supervisor with Customer Experience Essentials", + "name": "Assign or Unassign Agents to Supervisor with Customer Assist", "request": { "body": { "mode": "raw", @@ -306112,7 +308891,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306170,7 +308949,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306228,7 +309007,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306295,7 +309074,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306353,7 +309132,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306411,7 +309190,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306469,7 +309248,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306527,7 +309306,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306585,7 +309364,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306643,7 +309422,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306701,7 +309480,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306759,7 +309538,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306817,7 +309596,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306875,7 +309654,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306933,7 +309712,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -306991,7 +309770,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -307049,7 +309828,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -307107,7 +309886,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify a supervisor with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -307126,7 +309905,7 @@ ] }, { - "name": "List Available Supervisors with Customer Experience Essentials", + "name": "List Available Supervisors with Customer Assist", "request": { "description": "Get list of available supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ @@ -307178,7 +309957,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307239,7 +310018,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307301,7 +310080,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307363,7 +310142,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307425,7 +310204,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307487,7 +310266,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307549,7 +310328,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307611,7 +310390,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307673,7 +310452,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307735,7 +310514,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307797,7 +310576,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307859,7 +310638,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307931,7 +310710,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -307993,7 +310772,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308055,7 +310834,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308117,7 +310896,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308179,7 +310958,7 @@ "value": "" }, { - "description": "Returns only the list of available supervisors with Customer Experience Essentials license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", + "description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308192,7 +310971,7 @@ ] }, { - "name": "List Available Agents with Customer Experience Essentials", + "name": "List Available Agents with Customer Assist", "request": { "description": "Get list of available agents for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ @@ -308244,7 +311023,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308305,7 +311084,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308367,7 +311146,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308429,7 +311208,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308491,7 +311270,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308553,7 +311332,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308615,7 +311394,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308677,7 +311456,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308739,7 +311518,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308801,7 +311580,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308863,7 +311642,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308925,7 +311704,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -308987,7 +311766,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -309059,7 +311838,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -309121,7 +311900,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -309183,7 +311962,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -309245,7 +312024,7 @@ "value": "" }, { - "description": "Returns only the list of available agents with Customer Experience Essentials license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", + "description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license.", "key": "hasCxEssentials", "value": "" } @@ -309258,7 +312037,7 @@ ] }, { - "name": "Read the List of Call Queue Agents with Customer Experience Essentials", + "name": "Read the List of Call Queue Agents with Customer Assist", "request": { "description": "List all Call Queues Agents for the organization.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The decoded value of the agent's `id`, and the `type` returned in the response, are always returned as `PEOPLE`, even when the agent is a workspace or virtual line. This will be addressed in a future release.", "header": [ @@ -309320,7 +312099,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309396,7 +312175,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309473,7 +312252,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309550,7 +312329,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309627,7 +312406,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309723,7 +312502,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309800,7 +312579,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309877,7 +312656,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -309954,7 +312733,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310031,7 +312810,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310108,7 +312887,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310185,7 +312964,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310262,7 +313041,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310339,7 +313118,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310416,7 +313195,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310493,7 +313272,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310570,7 +313349,7 @@ "value": "" }, { - "description": "Returns only the list of call queues with Customer Experience Essentials license when `true`, otherwise returns the list of Customer Experience Basic call queues.", + "description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues.", "key": "hasCxEssentials", "value": "" }, @@ -310588,7 +313367,7 @@ ] }, { - "name": "Get Details for a Call Queue Agent with Customer Experience Essentials", + "name": "Get Details for a Call Queue Agent with Customer Assist", "request": { "description": "Retrieve details of a particular Call queue agent based on the agent ID.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving a call queue agent's details require a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The agent's `type` returned in the response and in the decoded value of the agent's `id`, is always of type `PEOPLE`, even if the agent is a workspace or virtual line. This` will be corrected in a future release.", "header": [ @@ -310616,7 +313395,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310670,7 +313449,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310724,7 +313503,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310778,7 +313557,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310832,7 +313611,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310886,7 +313665,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310940,7 +313719,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -310994,7 +313773,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311048,7 +313827,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311102,7 +313881,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311156,7 +313935,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311210,7 +313989,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311264,7 +314043,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311328,7 +314107,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311382,7 +314161,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311436,7 +314215,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311490,7 +314269,7 @@ "value": "" }, { - "description": "Must be set to `true` to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" }, @@ -311519,7 +314298,7 @@ ] }, { - "name": "Update an Agent's Settings of One or More Call Queues with Customer Experience Essentials", + "name": "Update an Agent's Settings of One or More Call Queues with Customer Assist", "request": { "body": { "mode": "raw", @@ -311558,7 +314337,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311618,7 +314397,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311678,7 +314457,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311738,7 +314517,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311798,7 +314577,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311858,7 +314637,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311918,7 +314697,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -311978,7 +314757,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312038,7 +314817,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312098,7 +314877,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312158,7 +314937,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312218,7 +314997,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312278,7 +315057,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312338,7 +315117,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312398,7 +315177,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312458,7 +315237,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312518,7 +315297,7 @@ "value": "" }, { - "description": "Must be set to `true` to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to `false`.", + "description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`.", "key": "hasCxEssentials", "value": "" } @@ -312549,7 +315328,7 @@ }, "raw": "{}" }, - "description": "Switches the current operating mode of the `Call Queue` to the mode as per normal operations.\n\nSwitching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "description": "Switches the current operating mode of the `Call Queue` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -340073,7 +342852,7 @@ }, "raw": "{\n \"name\": \"\",\n \"callPolicies\": {\n \"policy\": \"CIRCULAR\",\n \"noAnswer\": {\n \"nextAgentEnabled\": \"\",\n \"nextAgentRings\": \"\",\n \"forwardEnabled\": \"\",\n \"numberOfRings\": \"\",\n \"destinationVoicemailEnabled\": \"\",\n \"destination\": \"\"\n },\n \"waitingEnabled\": \"\",\n \"groupBusyEnabled\": \"\",\n \"allowMembersToControlGroupBusyEnabled\": \"\",\n \"busyRedirect\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"businessContinuityRedirect\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n \"agents\": [\n {\n \"id\": \"\",\n \"weight\": \"\"\n },\n {\n \"id\": \"\",\n \"weight\": \"\"\n }\n ],\n \"enabled\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"timeZone\": \"\",\n \"huntGroupCallerIdForOutgoingCallsEnabled\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"DISPLAY_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Create new Hunt Groups for the given location.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nCreating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Create new Hunt Groups for the given location.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nCreating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -341739,7 +344518,7 @@ { "name": "Get Details for a Hunt Group", "request": { - "description": "Retrieve Hunt Group details.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve Hunt Group details.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -342511,7 +345290,7 @@ }, "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"distinctiveRing\": \"\",\n \"alternateNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"SHORT_SHORT_LONG\"\n },\n {\n \"phoneNumber\": \"\",\n \"ringPattern\": \"LONG_LONG\"\n }\n ],\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"timeZone\": \"\",\n \"callPolicies\": {\n \"policy\": \"SIMULTANEOUS\",\n \"noAnswer\": {\n \"nextAgentEnabled\": \"\",\n \"nextAgentRings\": \"\",\n \"forwardEnabled\": \"\",\n \"numberOfRings\": \"\",\n \"destinationVoicemailEnabled\": \"\",\n \"destination\": \"\"\n },\n \"waitingEnabled\": \"\",\n \"groupBusyEnabled\": \"\",\n \"allowMembersToControlGroupBusyEnabled\": \"\",\n \"busyRedirect\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"businessContinuityRedirect\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n \"agents\": [\n {\n \"id\": \"\",\n \"weight\": \"\"\n },\n {\n \"id\": \"\",\n \"weight\": \"\"\n }\n ],\n \"huntGroupCallerIdForOutgoingCallsEnabled\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Update the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nUpdating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Update the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nUpdating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -344290,7 +347069,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "description": "Update Call Forwarding settings for the specified Hunt Group.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ @@ -344352,7 +347131,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344412,7 +347191,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344472,7 +347251,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344532,7 +347311,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344592,7 +347371,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344652,7 +347431,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344712,7 +347491,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344772,7 +347551,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344832,7 +347611,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344892,7 +347671,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -344952,7 +347731,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -345012,7 +347791,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -345072,7 +347851,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -345132,7 +347911,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -345192,7 +347971,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -345252,7 +348031,7 @@ "language": "json" } }, - "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"DO_NOT_FORWARD\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n}" + "raw": "{\n \"callForwarding\": {\n \"always\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"selective\": {\n \"enabled\": \"\",\n \"destination\": \"\",\n \"ringReminderEnabled\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n },\n \"rules\": [\n {\n \"id\": \"\",\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"enabled\": \"\"\n }\n ],\n \"operatingModes\": {\n \"enabled\": \"\",\n \"modes\": [\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_DEFAULT_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n },\n {\n \"normalOperationEnabled\": \"\",\n \"id\": \"\",\n \"forwardTo\": {\n \"selection\": \"FORWARD_TO_SPECIFIED_NUMBER\",\n \"destination\": \"\",\n \"destinationVoicemailEnabled\": \"\"\n }\n }\n ]\n }\n }\n}" }, "header": [ { @@ -352307,7 +355086,7 @@ }, "raw": "{}" }, - "description": "Switches the current operating mode of the `Hunt Group` to the mode as per normal operations.\n\nSwitching operating mode for a `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "description": "Switches the current operating mode of the `Hunt Group` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -363676,7 +366455,7 @@ }, "raw": "{\n \"name\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"originatorCallerIdEnabled\": \"\",\n \"originators\": [\n \"\",\n \"\"\n ],\n \"targets\": [\n \"\",\n \"\"\n ],\n \"directLineCallerIdName\": {\n \"selection\": \"DISPLAY_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -365342,7 +368121,7 @@ { "name": "Get Details for a Paging Group", "request": { - "description": "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -366114,7 +368893,7 @@ }, "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"languageCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"originatorCallerIdEnabled\": \"\",\n \"originators\": [\n \"\",\n \"\"\n ],\n \"targets\": [\n \"\",\n \"\"\n ],\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -411582,7 +414361,7 @@ { "name": "Get VoicePortal", "request": { - "description": "Retrieve Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant announcements.\n\nRetrieving voice portal information for an organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant announcements.\n\nRetrieving voice portal information for an organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -412268,7 +415047,7 @@ }, "raw": "{\n \"name\": \"\",\n \"languageCode\": \"\",\n \"extension\": \"\",\n \"phoneNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"passcode\": {\n \"newPasscode\": \"\",\n \"confirmPasscode\": \"\"\n },\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Update Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant anouncements.\n\nUpdating voice portal information for an organization and/or rules requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Update Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant anouncements.\n\nUpdating voice portal information for an organization and/or rules requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -414831,7 +417610,7 @@ { "name": "Get Location Voicemail Group", "request": { - "description": "Retrieve voicemail group details for a location.\n\nManage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nRetrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve voicemail group details for a location.\n\nManage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nRetrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -415603,7 +418382,7 @@ }, "raw": "{\n \"name\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"enabled\": \"\",\n \"passcode\": \"\",\n \"languageCode\": \"\",\n \"greeting\": \"CUSTOM\",\n \"greetingDescription\": \"\",\n \"messageStorage\": {\n \"storageType\": \"INTERNAL\",\n \"externalEmail\": \"\"\n },\n \"notifications\": {\n \"enabled\": \"\",\n \"destination\": \"\"\n },\n \"faxMessage\": {\n \"enabled\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n },\n \"transferToNumber\": {\n \"enabled\": \"\",\n \"destination\": \"\"\n },\n \"emailCopyOfMessage\": {\n \"enabled\": \"\",\n \"emailId\": \"\"\n },\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Modifies the voicemail group location details for a particular location for a customer.\n\nManage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nModifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Modifies the voicemail group location details for a particular location for a customer.\n\nManage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nModifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -417352,7 +420131,7 @@ }, "raw": "{\n \"name\": \"\",\n \"extension\": \"\",\n \"passcode\": \"\",\n \"languageCode\": \"\",\n \"messageStorage\": {\n \"storageType\": \"INTERNAL\",\n \"externalEmail\": \"\"\n },\n \"notifications\": {\n \"enabled\": \"\",\n \"destination\": \"\"\n },\n \"faxMessage\": {\n \"enabled\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n },\n \"transferToNumber\": {\n \"enabled\": \"\",\n \"destination\": \"\"\n },\n \"emailCopyOfMessage\": {\n \"enabled\": \"\",\n \"emailId\": \"\"\n },\n \"phoneNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Create a new voicemail group for the given location for a customer.\n\nA voicemail group can be created for given location for a customer.\n\nCreating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Create a new voicemail group for the given location for a customer.\n\nA voicemail group can be created for given location for a customer.\n\nCreating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -441702,7 +444481,7 @@ { "name": "List People", "request": { - "description": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", + "description": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).", "header": [ { "key": "Accept", @@ -471919,7 +474698,7 @@ { "name": "Read Caller ID Settings for a Person", "request": { - "description": "Retrieve a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.", "header": [ { "key": "Accept", @@ -472588,7 +475367,7 @@ }, "raw": "{\n \"selected\": \"CUSTOM\",\n \"customNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"blockInForwardCallsEnabled\": \"\",\n \"externalCallerIdNamePolicy\": \"LOCATION\",\n \"customExternalCallerIdName\": \"\",\n \"additionalExternalCallerIdDirectLineEnabled\": \"\",\n \"additionalExternalCallerIdLocationNumberEnabled\": \"\",\n \"additionalExternalCallerIdCustomNumber\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByFirstName\": \"\",\n \"dialByLastName\": \"\"\n}" }, - "description": "Configure a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Configure a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.", "header": [ { "key": "Content-Type", @@ -577095,16 +579874,11 @@ "status": "Service Unavailable" } ] - } - ], - "name": "User Call Settings (2/2)" - }, - { - "item": [ + }, { - "name": "Read the List of Virtual Lines", + "name": "Get Timezone and Announcement Language Settings of a Person", "request": { - "description": "List all Virtual Lines for the organization.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "description": "Retrieve a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -577119,111 +579893,34 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, - { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&locationId=&max=&start=&id=&id=&ownerName=&ownerName=&phoneNumber=&phoneNumber=&locationName=&locationName=&order=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 503, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -577234,82 +579931,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Gone" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 410, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -577320,84 +579970,47 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, + "_postman_previewlanguage": "json", + "body": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -577406,74 +580019,27 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Bad Gateway" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -577492,71 +580058,24 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, "status": "Internal Server Error" @@ -577564,10 +580083,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 428, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -577578,82 +580097,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 415, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -577664,103 +580136,37 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Precondition Required" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"virtualLines\": [\n {\n \"id\": \"\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"externalCallerIdNamePolicy\": \"DIRECT_LINE\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\",\n \"routingPrefix\": \"\",\n \"esn\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"numberOfDevicesAssigned\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"customExternalCallerIdName\": \"\",\n \"billingPlan\": \"\"\n },\n {\n \"id\": \"\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"externalCallerIdNamePolicy\": \"OTHER\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\",\n \"routingPrefix\": \"\",\n \"esn\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"numberOfDevicesAssigned\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"customExternalCallerIdName\": \"\",\n \"billingPlan\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 423, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "disabled": false, - "key": "Link", - "value": "" - } - ], - "name": "OK", + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -577769,82 +580175,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 405, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -577855,82 +580214,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 504, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -577941,74 +580253,27 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Too Many Requests" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -578027,71 +580292,24 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, "status": "Unauthorized" @@ -578099,10 +580317,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 429, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -578113,82 +580331,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 403, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -578199,82 +580370,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Gateway Timeout" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 404, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -578285,82 +580409,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 502, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -578371,74 +580448,27 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -578457,71 +580487,24 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, "status": "Bad Request" @@ -578529,10 +580512,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 409, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -578543,79 +580526,32 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "List virtual lines for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" - }, - { - "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", - "key": "locationId", - "value": "" - }, - { - "description": "Limit the number of objects returned to this maximum count.", - "key": "max", - "value": "" - }, - { - "description": "Start at the zero-based offset in the list of matching objects.", - "key": "start", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", - "key": "id", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", - "key": "ownerName", - "value": "" - }, - { - "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", - "key": "phoneNumber", - "value": "" - }, - { - "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", - "key": "locationName", - "value": "" - }, + } + ], + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ { - "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", - "key": "order", + "description": "Retrieve timezone and announcement language settings of this person.", + "key": "personId", "value": "" - }, - { - "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", - "key": "hasDeviceAssigned", - "value": "" - }, - { - "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", - "key": "hasExtensionAssigned", - "value": "" - }, - { - "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", - "key": "hasDnAssigned", - "value": "" } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + ] } }, - "status": "Method Not Allowed" + "status": "Conflict" } ] }, { - "name": "Create a Virtual Line", + "name": "Update Timezone and Announcement Language Settings of a Person", "request": { "body": { "mode": "raw", @@ -578625,20 +580561,16 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, - "description": "Create new Virtual Line for the given location.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nCreating a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "description": "Modify a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578646,26 +580578,34 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 410, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -578675,7 +580615,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578683,7 +580623,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578691,27 +580631,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 404, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -578721,7 +580669,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578729,7 +580677,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578737,27 +580685,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 423, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -578767,7 +580723,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578775,7 +580731,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578783,27 +580739,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 204, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "No Content", "originalRequest": { "body": { "mode": "raw", @@ -578813,7 +580777,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578821,7 +580785,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578829,27 +580793,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 428, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -578859,7 +580831,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578867,7 +580839,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578875,27 +580847,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -578905,7 +580885,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578913,7 +580893,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578921,27 +580901,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 409, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -578951,7 +580939,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -578959,7 +580947,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -578967,27 +580955,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 502, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -578997,7 +580993,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579005,7 +581001,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579013,27 +581009,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -579043,7 +581047,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579051,7 +581055,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579059,27 +581063,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 415, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -579089,7 +581101,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579097,7 +581109,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579105,27 +581117,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 504, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { "mode": "raw", @@ -579135,7 +581155,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579143,7 +581163,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579151,27 +581171,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 400, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -579181,7 +581209,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579189,7 +581217,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579197,27 +581225,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 503, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -579227,7 +581263,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579235,7 +581271,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579243,27 +581279,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 429, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -579273,7 +581317,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579281,7 +581325,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579289,27 +581333,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 405, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -579319,7 +581371,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -579327,7 +581379,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579335,32 +581387,35 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -579370,19 +581425,15 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + "raw": "{\n \"announcementLanguage\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -579390,26 +581441,34 @@ "path": [ "telephony", "config", - "virtualLines" + "people", + ":personId" ], "query": [ { - "description": "Create the virtual line for this organization.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + "raw": "{{baseUrl}}/telephony/config/people/:personId?orgId=", + "variable": [ + { + "description": "Modify timezone and announcement language settings of this person.", + "key": "personId", + "value": "" + } + ] } }, - "status": "Created" + "status": "Forbidden" } ] }, { - "name": "Read Call Recording Settings for a Virtual Line", + "name": "Get Country Calling Configuration", "request": { - "description": "Retrieve Virtual Line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_read` scope.", + "description": "Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones.\n\nThis information helps administrators configure user settings with valid timezone and location data for a specific country.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -579424,22 +581483,21 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId", + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", "value": "" } ] @@ -579449,10 +581507,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 403, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -579463,47 +581521,37 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"enabled\": \"\",\n \"record\": \"Always\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Play Announcement\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"serviceProvider\": \"\",\n \"externalGroup\": \"\",\n \"externalIdentifier\": \"\",\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 423, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -579512,35 +581560,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "OK" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 405, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -579551,35 +581599,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Conflict" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 503, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -579590,35 +581638,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Not Found" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 401, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -579629,35 +581677,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 500, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], "method": "GET", @@ -579668,35 +581716,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 404, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -579707,35 +581755,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 502, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -579746,35 +581794,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 429, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -579785,27 +581833,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Gone" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -579824,22 +581872,22 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } @@ -579849,10 +581897,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 428, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -579863,35 +581911,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 415, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -579902,35 +581950,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 410, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -579941,37 +581989,47 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Method Not Allowed" + "status": "Gone" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"stateRequired\": \"\",\n \"zipCodeRequired\": \"\",\n \"states\": [\n {\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\"\n }\n ],\n \"timeZones\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -579980,35 +582038,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 409, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -580019,35 +582077,35 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 504, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -580058,51 +582116,46 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "countries", + ":countryCode" ], "query": [ { - "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Organization ID. If not specified, uses the organization from the OAuth token.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", + "raw": "{{baseUrl}}/telephony/config/countries/:countryCode?orgId=", "variable": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "The ISO country code to retrieve configuration for.", + "key": "countryCode", + "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" } ] - }, + } + ], + "name": "User Call Settings (2/2)" + }, + { + "item": [ { - "name": "Configure Call Recording Settings for a Virtual Line", + "name": "Read the List of Virtual Lines", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" - }, - "description": "Configure virtual line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.", + "description": "List all Virtual Lines for the organization.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -580110,53 +582163,114 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "List virtual lines for this organization.", "key": "orgId", "value": "" - } - ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ + }, { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId", + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&locationId=&max=&start=&id=&id=&ownerName=&ownerName=&phoneNumber=&phoneNumber=&locationName=&locationName=&order=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 410, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -580164,28 +582278,1298 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "List virtual lines for this organization.", "key": "orgId", "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"virtualLines\": [\n {\n \"id\": \"\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"externalCallerIdNamePolicy\": \"DIRECT_LINE\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\",\n \"routingPrefix\": \"\",\n \"esn\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"numberOfDevicesAssigned\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"customExternalCallerIdName\": \"\",\n \"billingPlan\": \"\"\n },\n {\n \"id\": \"\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"externalCallerIdNamePolicy\": \"OTHER\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\",\n \"routingPrefix\": \"\",\n \"esn\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"numberOfDevicesAssigned\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"customExternalCallerIdName\": \"\",\n \"billingPlan\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "", + "type": "text/plain" + }, + "disabled": false, + "key": "Link", + "value": "" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" } }, "status": "Unsupported Media Type" }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Bad Request" + }, { "_postman_previewlanguage": "text", "body": null, @@ -580193,6 +583577,139 @@ "cookie": [], "header": [], "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "List virtual lines for this organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.", + "key": "locationId", + "value": "" + }, + { + "description": "Limit the number of objects returned to this maximum count.", + "key": "max", + "value": "" + }, + { + "description": "Start at the zero-based offset in the list of matching objects.", + "key": "start", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.", + "key": "id", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.", + "key": "ownerName", + "value": "" + }, + { + "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.", + "key": "phoneNumber", + "value": "" + }, + { + "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.", + "key": "locationName", + "value": "" + }, + { + "description": "Return the list of virtual lines based on the order. Default sort will be\u00a0in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`.", + "key": "order", + "value": "" + }, + { + "description": "If `true`, includes only\u00a0virtual lines with devices assigned. When not explicitly specified, the default includes both\u00a0virtual lines with devices assigned and not assigned.", + "key": "hasDeviceAssigned", + "value": "" + }, + { + "description": "If `true`, includes\u00a0only virtual lines with\u00a0an extension assigned. When not explicitly specified, the default includes both virtual lines with\u00a0extension assigned and not assigned.", + "key": "hasExtensionAssigned", + "value": "" + }, + { + "description": "If `true`, includes only virtual lines with\u00a0an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with\u00a0a Dn assigned and not assigned.", + "key": "hasDnAssigned", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=&locationId=&max=&start=&id=&ownerName=&phoneNumber=&locationName=&order=&hasDeviceAssigned=&hasExtensionAssigned=&hasDnAssigned=" + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Create a Virtual Line", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + }, + "description": "Create new Virtual Line for the given location.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nCreating a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ + { + "description": "Create the virtual line for this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -580202,7 +583719,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580210,7 +583727,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580218,35 +583735,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Method Not Allowed" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 428, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -580256,7 +583765,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580264,7 +583773,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580272,35 +583781,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 410, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -580310,7 +583811,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580318,7 +583819,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580326,35 +583827,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 415, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -580364,7 +583857,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580372,7 +583865,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580380,35 +583873,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Service Unavailable" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 405, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -580418,7 +583903,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580426,7 +583911,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580434,35 +583919,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 503, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -580472,7 +583949,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580480,7 +583957,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580488,35 +583965,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 401, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -580526,7 +583995,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580534,7 +584003,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580542,35 +584011,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 409, "cookie": [], "header": [], - "name": "No Content", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -580580,7 +584041,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580588,7 +584049,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580596,35 +584057,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "No Content" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 429, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -580634,7 +584087,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580642,7 +584095,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580650,27 +584103,19 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -580688,7 +584133,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580696,7 +584141,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580704,24 +584149,16 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, "status": "Forbidden" @@ -580742,7 +584179,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580750,7 +584187,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580758,24 +584195,16 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, "status": "Bad Gateway" @@ -580783,10 +584212,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 500, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -580796,7 +584225,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580804,7 +584233,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580812,35 +584241,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Gateway Timeout" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 504, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { "mode": "raw", @@ -580850,7 +584271,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580858,7 +584279,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580866,35 +584287,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 400, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -580904,7 +584317,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580912,7 +584325,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580920,35 +584333,27 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ - { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" - } - ] + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 404, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -580958,7 +584363,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" }, "header": [ { @@ -580966,7 +584371,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -580974,36 +584379,88 @@ "path": [ "telephony", "config", - "virtualLines", - ":virtualLineId", - "callRecording" + "virtualLines" ], "query": [ { - "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", + "description": "Create the virtual line for this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", - "variable": [ + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines" + ], + "query": [ { - "description": "Unique identifier for the virtual line.", - "key": "virtualLineId" + "description": "Create the virtual line for this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines?orgId=" } }, - "status": "Bad Request" + "status": "Created" } ] }, { - "name": "Delete a Virtual Line", + "name": "Read Call Recording Settings for a Virtual Line", "request": { - "description": "Delete the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nDeleting a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", - "header": [], - "method": "DELETE", + "description": "Retrieve Virtual Line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_read` scope.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581012,19 +584469,20 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId", "value": "" } @@ -581035,13 +584493,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 502, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581050,36 +584508,47 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Gone" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 423, + "_postman_previewlanguage": "json", + "body": "{\n \"enabled\": \"\",\n \"record\": \"Always\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Play Announcement\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"serviceProvider\": \"\",\n \"externalGroup\": \"\",\n \"externalIdentifier\": \"\",\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581088,36 +584557,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 409, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581126,36 +584596,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 404, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581164,36 +584635,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 423, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581202,25 +584674,26 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", @@ -581231,7 +584704,7 @@ "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581240,19 +584713,20 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] @@ -581263,13 +584737,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 504, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581278,36 +584752,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Unauthorized" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 500, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581316,36 +584791,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 410, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581354,36 +584830,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Service Unavailable" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 400, "cookie": [], "header": [], - "name": "No Content", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581392,36 +584869,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "No Content" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581430,36 +584908,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 401, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581468,36 +584947,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 405, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581506,36 +584986,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 403, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581544,36 +585025,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Unsupported Media Type" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 429, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581582,36 +585064,37 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 503, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -581620,39 +585103,50 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Delete the virtual line from this organization.", + "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Delete the virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" } ] }, { - "name": "Get Details for a Virtual Line", + "name": "Configure Call Recording Settings for a Virtual Line", "request": { - "description": "Retrieve Virtual Line details.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving virtual line details requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "description": "Configure virtual line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581661,19 +585155,20 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId", "value": "" } @@ -581684,13 +585179,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 415, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581699,46 +585209,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"directorySearchEnabled\": \"\",\n \"announcementLanguage\": \"\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\",\n \"address\": {\n \"address1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"address2\": \"\"\n }\n },\n \"displayName\": \"\",\n \"timeZone\": \"\",\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"ACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"ACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 405, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581747,36 +585263,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "OK" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 404, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581785,36 +585317,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 429, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581823,36 +585371,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 503, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581861,36 +585425,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 410, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581899,25 +585479,26 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Precondition Required" + "status": "Gone" }, { "_postman_previewlanguage": "text", @@ -581927,8 +585508,23 @@ "header": [], "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581937,19 +585533,20 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] @@ -581960,13 +585557,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 428, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -581975,36 +585587,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Too Many Requests" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 204, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "No Content", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582013,36 +585641,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Gone" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 500, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582051,36 +585695,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Unsupported Media Type" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 403, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582089,36 +585749,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 502, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582127,36 +585803,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 504, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582165,36 +585857,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 409, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582203,36 +585911,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582241,36 +585965,52 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 400, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"record\": \"Always with Pause/Resume\",\n \"recordVoicemailEnabled\": \"\",\n \"notification\": {\n \"type\": \"Beep\",\n \"enabled\": \"\"\n },\n \"repeat\": {\n \"interval\": \"\",\n \"enabled\": \"\"\n },\n \"startStopAnnouncement\": {\n \"internalCallsEnabled\": \"\",\n \"pstnCallsEnabled\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -582279,49 +586019,35 @@ "telephony", "config", "virtualLines", - ":virtualLineId" + ":virtualLineId", + "callRecording" ], "query": [ { - "description": "Retrieve virtual line settings from this organization.", + "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording?orgId=", "variable": [ { - "description": "Retrieve settings for a virtual line with the matching ID.", + "description": "Unique identifier for the virtual line.", "key": "virtualLineId" } ] } }, - "status": "Bad Gateway" + "status": "Bad Request" } ] }, { - "name": "Update a Virtual Line", + "name": "Delete a Virtual Line", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "description": "Update the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating a virtual line requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "description": "Delete the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nDeleting a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582334,7 +586060,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582342,7 +586068,7 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId", "value": "" } @@ -582353,28 +586079,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 410, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582387,7 +586098,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582395,39 +586106,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 423, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582440,7 +586136,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582448,39 +586144,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 502, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582493,7 +586174,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582501,39 +586182,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 429, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582546,7 +586212,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582554,39 +586220,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 500, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582599,7 +586250,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582607,39 +586258,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 428, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582652,7 +586288,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582660,39 +586296,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Not Found" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 401, "cookie": [], "header": [], - "name": "No Content", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582705,7 +586326,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582713,39 +586334,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "No Content" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 409, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582758,7 +586364,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582766,39 +586372,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Unsupported Media Type" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 503, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582811,7 +586402,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582819,39 +586410,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 204, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "No Content", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582864,7 +586440,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582872,39 +586448,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Gone" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 404, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582917,7 +586478,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582925,39 +586486,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Bad Gateway" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 400, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -582970,7 +586516,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -582978,39 +586524,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 403, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -583023,7 +586554,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -583031,39 +586562,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 415, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -583076,7 +586592,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -583084,39 +586600,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 405, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -583129,7 +586630,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -583137,39 +586638,24 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Gateway Timeout" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 504, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -583182,7 +586668,7 @@ ], "query": [ { - "description": "Update virtual line settings from this organization.", + "description": "Delete the virtual line from this organization.", "key": "orgId", "value": "" } @@ -583190,20 +586676,20 @@ "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { - "description": "Update settings for a virtual line with the matching ID.", + "description": "Delete the virtual line with the matching ID.", "key": "virtualLineId" } ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" } ] }, { - "name": "Get Phone Number assigned for a Virtual Line", + "name": "Get Details for a Virtual Line", "request": { - "description": "Get details on the assigned phone number and extension for the virtual line.\n\nRetrieving virtual line phone number details requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "description": "Retrieve Virtual Line details.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving virtual line details requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -583219,8 +586705,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583229,7 +586714,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583243,10 +586728,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 504, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -583258,8 +586743,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583268,7 +586752,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583277,17 +586761,27 @@ ] } }, - "status": "Internal Server Error" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"directorySearchEnabled\": \"\",\n \"announcementLanguage\": \"\",\n \"number\": {\n \"primary\": \"\",\n \"external\": \"\",\n \"extension\": \"\"\n },\n \"location\": {\n \"id\": \"\",\n \"name\": \"\",\n \"address\": {\n \"address1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\",\n \"address2\": \"\"\n }\n },\n \"displayName\": \"\",\n \"timeZone\": \"\",\n \"devices\": [\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"ACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\"\n },\n {\n \"id\": \"\",\n \"model\": \"\",\n \"primaryOwner\": \"\",\n \"type\": \"SHARED_CALL_APPEARANCE\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"activationState\": \"ACTIVATED\",\n \"description\": [\n \"\",\n \"\"\n ],\n \"mac\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -583297,8 +586791,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583307,7 +586800,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583316,15 +586809,15 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 503, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -583336,8 +586829,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583346,7 +586838,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583355,15 +586847,15 @@ ] } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 400, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -583375,8 +586867,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583385,7 +586876,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583394,15 +586885,15 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 405, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -583414,8 +586905,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583424,7 +586914,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583433,15 +586923,15 @@ ] } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 428, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -583453,8 +586943,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583463,7 +586952,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583472,15 +586961,15 @@ ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 423, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], "method": "GET", @@ -583492,8 +586981,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583502,7 +586990,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583511,15 +586999,15 @@ ] } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 429, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -583531,8 +587019,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583541,7 +587028,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583550,15 +587037,15 @@ ] } }, - "status": "Method Not Allowed" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 410, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -583570,8 +587057,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583580,7 +587066,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583589,15 +587075,15 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -583609,8 +587095,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583619,7 +587104,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583628,7 +587113,7 @@ ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", @@ -583648,8 +587133,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583658,7 +587142,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583672,10 +587156,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 403, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -583687,8 +587171,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583697,7 +587180,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583706,27 +587189,17 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"phoneNumber\": {\n \"primary\": \"\",\n \"directNumber\": \"\",\n \"extension\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -583736,8 +587209,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583746,7 +587218,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583755,15 +587227,15 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 401, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -583775,8 +587247,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583785,7 +587256,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583794,15 +587265,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 404, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -583814,8 +587285,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583824,7 +587294,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583833,15 +587303,15 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 502, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -583853,8 +587323,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "number" + ":virtualLineId" ], "query": [ { @@ -583863,7 +587332,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -583872,12 +587341,12 @@ ] } }, - "status": "Gone" + "status": "Bad Gateway" } ] }, { - "name": "Update Directory search for a Virtual Line", + "name": "Update a Virtual Line", "request": { "body": { "mode": "raw", @@ -583887,9 +587356,9 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, - "description": "Update the directory search for a designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating Directory search for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", + "description": "Update the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating a virtual line requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", "header": [ { "key": "Content-Type", @@ -583905,8 +587374,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -583915,7 +587383,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -583929,10 +587397,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 405, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -583942,7 +587410,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -583959,8 +587427,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -583969,7 +587436,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -583978,15 +587445,15 @@ ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 503, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -583996,7 +587463,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584013,8 +587480,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584023,7 +587489,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584032,15 +587498,15 @@ ] } }, - "status": "Bad Gateway" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 400, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -584050,7 +587516,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584067,8 +587533,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584077,7 +587542,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584086,15 +587551,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 403, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -584104,7 +587569,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584121,8 +587586,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584131,7 +587595,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584140,15 +587604,15 @@ ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 429, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -584158,7 +587622,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584175,8 +587639,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584185,7 +587648,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584194,15 +587657,15 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 404, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -584212,7 +587675,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584229,8 +587692,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584239,7 +587701,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584248,7 +587710,7 @@ ] } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -584266,7 +587728,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584283,8 +587745,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584293,7 +587754,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584307,10 +587768,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 415, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -584320,7 +587781,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584337,8 +587798,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584347,7 +587807,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584356,15 +587816,15 @@ ] } }, - "status": "Gateway Timeout" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 423, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -584374,7 +587834,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584391,8 +587851,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584401,7 +587860,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584410,15 +587869,15 @@ ] } }, - "status": "Internal Server Error" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 410, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -584428,7 +587887,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584445,8 +587904,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584455,7 +587913,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584464,15 +587922,15 @@ ] } }, - "status": "Too Many Requests" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 502, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -584482,7 +587940,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584499,8 +587957,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584509,7 +587966,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584518,15 +587975,15 @@ ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 500, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -584536,7 +587993,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584553,8 +588010,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584563,7 +588019,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584572,15 +588028,15 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 409, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -584590,7 +588046,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584607,8 +588063,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584617,7 +588072,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584626,15 +588081,15 @@ ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -584644,7 +588099,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584661,8 +588116,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584671,7 +588125,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584680,15 +588134,15 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 504, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { "mode": "raw", @@ -584698,7 +588152,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584715,8 +588169,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584725,7 +588178,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584734,7 +588187,7 @@ ] } }, - "status": "Conflict" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -584752,7 +588205,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\"\n}" + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"announcementLanguage\": \"\",\n \"callerIdLastName\": \"\",\n \"callerIdFirstName\": \"\",\n \"callerIdNumber\": \"\",\n \"timeZone\": \"\"\n}" }, "header": [ { @@ -584769,8 +588222,7 @@ "telephony", "config", "virtualLines", - ":virtualLineId", - "directorySearch" + ":virtualLineId" ], "query": [ { @@ -584779,7 +588231,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId?orgId=", "variable": [ { "description": "Update settings for a virtual line with the matching ID.", @@ -584793,9 +588245,9 @@ ] }, { - "name": "Get List of Devices assigned for a Virtual Line", + "name": "Get Phone Number assigned for a Virtual Line", "request": { - "description": "Retrieve Device details assigned for a virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "description": "Get details on the assigned phone number and extension for the virtual line.\n\nRetrieving virtual line phone number details requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -584812,7 +588264,7 @@ "config", "virtualLines", ":virtualLineId", - "devices" + "number" ], "query": [ { @@ -584821,7 +588273,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -584835,10 +588287,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], "method": "GET", @@ -584851,7 +588303,7 @@ "config", "virtualLines", ":virtualLineId", - "devices" + "number" ], "query": [ { @@ -584860,7 +588312,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -584869,15 +588321,15 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 429, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -584890,7 +588342,7 @@ "config", "virtualLines", ":virtualLineId", - "devices" + "number" ], "query": [ { @@ -584899,7 +588351,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -584908,15 +588360,15 @@ ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 504, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -584929,7 +588381,7 @@ "config", "virtualLines", ":virtualLineId", - "devices" + "number" ], "query": [ { @@ -584938,7 +588390,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -584947,15 +588399,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -584968,7 +588420,7 @@ "config", "virtualLines", ":virtualLineId", - "devices" + "number" ], "query": [ { @@ -584977,7 +588429,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", "variable": [ { "description": "Retrieve settings for a virtual line with the matching ID.", @@ -584986,7 +588438,1599 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"phoneNumber\": {\n \"primary\": \"\",\n \"directNumber\": \"\",\n \"extension\": \"\"\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "number" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Gone" + } + ] + }, + { + "name": "Update Directory search for a Virtual Line", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "description": "Update the directory search for a designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating Directory search for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "directorySearch" + ], + "query": [ + { + "description": "Update virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch?orgId=", + "variable": [ + { + "description": "Update settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Get List of Devices assigned for a Virtual Line", + "request": { + "description": "Retrieve Device details assigned for a virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "devices" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "devices" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "devices" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "devices" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "virtualLines", + ":virtualLineId", + "devices" + ], + "query": [ + { + "description": "Retrieve virtual line settings from this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices?orgId=", + "variable": [ + { + "description": "Retrieve settings for a virtual line with the matching ID.", + "key": "virtualLineId" + } + ] + } + }, + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -586147,7 +591191,7 @@ { "name": "Read Caller ID Settings for a Virtual Line", "request": { - "description": "Retrieve a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nRetrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nRetrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { "key": "Accept", @@ -586833,7 +591877,7 @@ }, "raw": "{\n \"selected\": \"CUSTOM\",\n \"customNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"blockInForwardCallsEnabled\": \"\",\n \"externalCallerIdNamePolicy\": \"LOCATION\",\n \"customExternalCallerIdName\": \"\",\n \"additionalExternalCallerIdDirectLineEnabled\": \"\",\n \"additionalExternalCallerIdLocationNumberEnabled\": \"\",\n \"additionalExternalCallerIdCustomNumber\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByFirstName\": \"\",\n \"dialByLastName\": \"\"\n}" }, - "description": "Configure a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nUpdating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, `dialByFirstName`, and `dialByLastName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `firstName` and `lastName` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Configure a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nUpdating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -631926,7 +636970,7 @@ { "name": "Read Caller ID Settings for a Workspace", "request": { - "description": "Retrieve a workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `displayName` and `displayDetail` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Retrieve a workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.", "header": [ { "key": "Accept", @@ -632595,7 +637639,7 @@ }, "raw": "{\n \"selected\": \"DIRECT_LINE\",\n \"customNumber\": \"\",\n \"displayName\": \"\",\n \"displayDetail\": \"\",\n \"blockInForwardCallsEnabled\": \"\",\n \"externalCallerIdNamePolicy\": \"OTHER\",\n \"customExternalCallerIdName\": \"\",\n \"locationExternalCallerIdName\": \"\",\n \"directLineCallerIdName\": {\n \"selection\": \"CUSTOM_NAME\",\n \"customName\": \"\"\n },\n \"dialByName\": \"\"\n}" }, - "description": "Configure workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.
The fields `directLineCallerIdName.selection`, `directLineCallerIdName.customName`, and `dialByName` are not supported in Webex for Government (FedRAMP). Instead, administrators must use the `displayName` and `displayDetail` fields to configure and view both caller ID and dial-by-name settings.
", + "description": "Configure workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.", "header": [ { "key": "Content-Type", @@ -761625,7 +766669,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination.", "header": [ @@ -761668,7 +766712,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761707,7 +766751,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761746,7 +766790,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761785,7 +766829,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761824,7 +766868,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761868,7 +766912,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761911,7 +766955,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761950,7 +766994,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -761989,7 +767033,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762028,7 +767072,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762067,7 +767111,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762106,7 +767150,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762145,7 +767189,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762184,7 +767228,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762223,7 +767267,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -762262,7 +767306,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -768963,7 +774007,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command.", "header": [ @@ -769006,7 +774050,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769045,7 +774089,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769084,7 +774128,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769123,7 +774167,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769162,7 +774206,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769201,7 +774245,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769240,7 +774284,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769284,7 +774328,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769327,7 +774371,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769366,7 +774410,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769405,7 +774449,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769444,7 +774488,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769483,7 +774527,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769522,7 +774566,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769561,7 +774605,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -769600,7 +774644,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773596,7 +778640,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user's call pickup group. When target is present, the API pickups an incoming call from the specified target user.", "header": [ @@ -773639,7 +778683,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773683,7 +778727,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773726,7 +778770,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773765,7 +778809,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773804,7 +778848,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773843,7 +778887,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773882,7 +778926,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773921,7 +778965,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773960,7 +779004,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -773999,7 +779043,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774038,7 +779082,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774077,7 +779121,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774116,7 +779160,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774155,7 +779199,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774194,7 +779238,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774233,7 +779277,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774269,7 +779313,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "description": "Barge-in on another user's answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command.", "header": [ @@ -774312,7 +779356,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774351,7 +779395,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774390,7 +779434,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774429,7 +779473,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774468,7 +779512,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774507,7 +779551,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774546,7 +779590,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774585,7 +779629,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774624,7 +779668,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774663,7 +779707,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774702,7 +779746,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774741,7 +779785,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774780,7 +779824,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774824,7 +779868,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774867,7 +779911,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -774906,7 +779950,7 @@ "language": "json" } }, - "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"lineOwnerId\": \"\"\n}" + "raw": "{\n \"target\": \"\",\n \"endpointId\": \"\",\n \"singleNumberReachPhoneNumber\": \"\",\n \"lineOwnerId\": \"\"\n}" }, "header": [ { @@ -828489,62 +833533,12900 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "modeManagement", - "features", - ":featureId", - "actions", - "extendMode", - "invoke" + "people", + "me", + "settings", + "modeManagement", + "features", + ":featureId", + "actions", + "extendMode", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "variable": [ + { + "description": "Unique identifier for the feature.", + "key": "featureId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"operatingModeId\": \"\",\n \"extensionTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "modeManagement", + "features", + ":featureId", + "actions", + "extendMode", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "variable": [ + { + "description": "Unique identifier for the feature.", + "key": "featureId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Conflict", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"operatingModeId\": \"\",\n \"extensionTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "modeManagement", + "features", + ":featureId", + "actions", + "extendMode", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "variable": [ + { + "description": "Unique identifier for the feature.", + "key": "featureId", + "value": "" + } + ] + } + }, + "status": "Conflict" + } + ] + } + ], + "name": "Mode Management" + }, + { + "item": [ + { + "name": "Upload Voicemail Busy Greeting", + "request": { + "body": { + "mode": "params" + }, + "description": "Uploads a new busy greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 201, + "cookie": [], + "header": [], + "name": "Created", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "busyGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Upload Voicemail No Answer Greeting", + "request": { + "body": { + "mode": "params" + }, + "description": "Uploads a new no answer greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 201, + "cookie": [], + "header": [], + "name": "Created", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "params" + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "voicemail", + "actions", + "noAnswerGreetingUpload", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Retrieve My Simultaneous Ring Settings", + "request": { + "description": "Retrieve simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving settings requires a user auth token with a scope of `spark:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"criteriasEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationRequiredEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationRequiredEnabled\": \"\"\n }\n ],\n \"criteria\": [\n {\n \"id\": \"\",\n \"source\": \"ALL_NUMBERS\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\"\n },\n {\n \"id\": \"\",\n \"source\": \"SPECIFIC_NUMBERS\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Modify My Simultaneous Ring Settings", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "description": "Modify simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying settings requires a user auth token with a scope of `spark:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + } + }, + "status": "No Content" + } + ] + }, + { + "name": "Retrieve My Simultaneous Ring Criteria", + "request": { + "description": "Retrieve simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving criteria requires a user auth token with a scope of `spark:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Modify My Simultaneous Ring Criteria", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "description": "Modify simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying criteria requires a user auth token with a scope of `spark:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Delete My Simultaneous Ring Criteria", + "request": { + "description": "Delete simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nDeleting criteria requires a user auth token with a scope of `spark:telephony_config_write`.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria", + ":id" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", + "variable": [ + { + "description": "Unique identifier for the criteria.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + } + ] + }, + { + "name": "Create My Simultaneous Ring Criteria", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "Create simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nCreating criteria requires a user auth token with a scope of `spark:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Created" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "simultaneousRing", + "criteria" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + } + }, + "status": "Method Not Allowed" + } + ] + }, + { + "name": "Retrieve My Guest Calling Numbers", + "request": { + "description": "Retrieve available guest calling numbers for the authenticated user.\n\nThis API returns a list of phone numbers that can be used for guest calling purposes.\n\nRetrieving guest calling numbers requires a user auth token with a scope of `spark:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"state\": \"ACTIVE\",\n \"isMainNumber\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"state\": \"ACTIVE\",\n \"isMainNumber\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "people", + "me", + "settings", + "guestCalling", + "numbers" + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + } + }, + "status": "Bad Gateway" + } + ] + } + ], + "name": "Call Settings For Me Phase 4" + }, + { + "item": [ + { + "name": "List Wrap Up Reasons", + "request": { + "description": "Return the list of wrap-up reasons configured for a customer.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues. Upon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue. Admins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the list of wrap-up reasons requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"wrapupReasons\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"numberOfQueuesAssigned\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"numberOfQueuesAssigned\": \"\",\n \"description\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Unsupported Media Type" + } + ] + }, + { + "name": "Create Wrap Up Reason", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "description": "Create a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nCreating a wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"id\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queues\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons" + } + }, + "status": "Created" + } + ] + }, + { + "name": "Read Wrap Up Reason", + "request": { + "description": "Return the wrap-up reason by ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the wrap-up reason by ID requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"name\": \"\",\n \"defaultWrapupQueuesCount\": \"\",\n \"queues\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locationName\": \"\",\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"defaultWrapupEnabled\": \"\",\n \"extension\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locationName\": \"\",\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"defaultWrapupEnabled\": \"\",\n \"extension\": \"\"\n }\n ],\n \"description\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + } + ] + }, + { + "name": "Update Wrap Up Reason", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "description": "Modify a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nModifying a wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"queuesToAssign\": [\n \"\",\n \"\"\n ],\n \"queuesToUnassign\": [\n \"\",\n \"\"\n ],\n \"assignAllQueuesEnabled\": \"\",\n \"unassignAllQueuesEnabled\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Delete Wrap Up Reason", + "request": { + "description": "Delete a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nDeleting the wrap-up reason requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Validate Wrap Up Reason", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "description": "Validate the wrap-up reason name.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nValidating the wrap-up reason name requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + "actions", + "validateName", + "invoke" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke" + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Read Available Queues", + "request": { + "description": "Return the available queues for a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the available queues for a wrap-up reason requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"queues\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locationName\": \"\",\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locationName\": \"\",\n \"locationId\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "wrapup", + "reasons", + ":wrapupReasonId", + "availableQueues" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues", + "variable": [ + { + "description": "Wrap-up reason ID.", + "key": "wrapupReasonId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Read Wrap Up Reason Settings", + "request": { + "description": "Return a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nRetrieving the wrap-up reason by location ID and queue ID requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"wrapupReasons\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"isDefaultEnabled\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"isDefaultEnabled\": \"\",\n \"description\": \"\"\n }\n ],\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Update Wrap Up Reason Settings", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "description": "Modify a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default of 60 seconds. This timer can be disabled if necessary.\n\nModifying a wrap-up reason by location ID and queue ID requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapupReasons\": [\n \"\",\n \"\"\n ],\n \"defaultWrapupReasonId\": \"\",\n \"wrapupTimerEnabled\": \"\",\n \"wrapupTimer\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "cxEssentials", + "locations", + ":locationId", + "queues", + ":queueId", + "wrapup", + "settings" + ], + "raw": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings", + "variable": [ + { + "description": "The location ID.", + "key": "locationId", + "value": "" + }, + { + "description": "The queue ID.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gone" + } + ] + }, + { + "name": "Read Screen Pop Configuration", + "request": { + "description": "Returns the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nRetrieving the screen pop configuration requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" + ], + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "telephony", + "config", + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", "variable": [ { - "description": "Unique identifier for the feature.", - "key": "featureId", + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"operatingModeId\": \"\",\n \"extensionTime\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -828552,62 +846434,47 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "modeManagement", - "features", - ":featureId", - "actions", - "extendMode", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", "variable": [ { - "description": "Unique identifier for the feature.", - "key": "featureId", + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", "value": "" } ] } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"errors\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ],\n \"trackingId\": \"\"\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 428, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Conflict", + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"operatingModeId\": \"\",\n \"extensionTime\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -828615,49 +846482,60 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "modeManagement", - "features", - ":featureId", - "actions", - "extendMode", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke", + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", "variable": [ { - "description": "Unique identifier for the feature.", - "key": "featureId", + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", "value": "" } ] } }, - "status": "Conflict" + "status": "Precondition Required" } ] - } - ], - "name": "Mode Management" - }, - { - "item": [ + }, { - "name": "Upload Voicemail Busy Greeting", + "name": "Update Screen Pop Configuration", "request": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, - "description": "Uploads a new busy greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.", + "description": "Modifies the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nModifying the screen pop configuration requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.", "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828665,36 +846543,61 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 429, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828702,37 +846605,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 415, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828740,37 +846668,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 404, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828778,18 +846731,36 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { "_postman_previewlanguage": "text", @@ -828800,15 +846771,22 @@ "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828816,15 +846794,33 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, "status": "Bad Gateway" @@ -828832,21 +846828,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828854,37 +846857,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828892,37 +846920,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 409, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828930,37 +846983,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 428, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -828968,37 +847046,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 423, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829006,37 +847109,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 410, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829044,37 +847172,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829082,37 +847235,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 204, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "No Content", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829120,37 +847298,62 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 401, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829158,18 +847361,36 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -829177,18 +847398,25 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829196,15 +847424,33 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, "status": "Bad Request" @@ -829212,21 +847458,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 201, + "code": 504, "cookie": [], "header": [], - "name": "Created", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829234,18 +847487,36 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, - "status": "Created" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", @@ -829256,15 +847527,22 @@ "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { - "mode": "params" + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"enabled\": \"\",\n \"screenPopUrl\": \"\",\n \"desktopLabel\": \"\",\n \"queryParams\": {\n \"example_param_1\": \"\",\n \"example_param_2\": \"\",\n \"example_param_3\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", - "value": "multipart/form-data" + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -829272,15 +847550,33 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "busyGreetingUpload", - "invoke" + "locations", + ":locationId", + "queues", + ":queueId", + "cxEssentials", + "screenPop" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop?orgId=", + "variable": [ + { + "description": "The location ID where the call queue resides.", + "key": "locationId", + "value": "" + }, + { + "description": "The call queue ID for which screen pop configuration is modified.", + "key": "queueId", + "value": "" + } + ] } }, "status": "Method Not Allowed" @@ -829288,19 +847584,16 @@ ] }, { - "name": "Upload Voicemail No Answer Greeting", + "name": "List Available Agents", "request": { - "body": { - "mode": "params" - }, - "description": "Uploads a new no answer greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.", + "description": "Return a list of available agents with Customer Assist license in a location.\n\nRetrieving the list of available agents requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.", "header": [ { - "key": "Content-Type", - "value": "multipart/form-data" + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829308,36 +847601,45 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 201, + "code": 401, "cookie": [], "header": [], - "name": "Created", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829345,37 +847647,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Created" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 503, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829383,18 +847694,35 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -829404,16 +847732,8 @@ "header": [], "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829421,37 +847741,56 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"agents\": [\n {\n \"id\": \"\",\n \"type\": \"PEOPLE\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"hasCxEssentials\": \"\",\n \"phoneNumbers\": {\n \"external\": \"\",\n \"extension\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"VIRTUAL_LINE\",\n \"lastName\": \"\",\n \"firstName\": \"\",\n \"displayName\": \"\",\n \"email\": \"\",\n \"hasCxEssentials\": \"\",\n \"phoneNumbers\": {\n \"external\": \"\",\n \"extension\": \"\"\n }\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "body": { - "mode": "params" - }, "header": [ { - "key": "Content-Type", - "value": "multipart/form-data" + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829459,37 +847798,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 415, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829497,37 +847845,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 409, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829535,37 +847892,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 423, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829573,37 +847939,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 403, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829611,37 +847986,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Method Not Allowed" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 404, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829649,37 +848033,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 429, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829687,37 +848080,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 405, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829725,37 +848127,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 502, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829763,18 +848174,35 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -829782,18 +848210,10 @@ "code": 400, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829801,15 +848221,32 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, "status": "Bad Request" @@ -829817,21 +848254,13 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 428, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829839,37 +848268,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 500, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829877,37 +848315,46 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 410, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "body": { - "mode": "params" - }, - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -829915,25 +848362,47 @@ "path": [ "telephony", "config", - "people", - "me", - "settings", - "voicemail", - "actions", - "noAnswerGreetingUpload", - "invoke" + "locations", + ":locationId", + "cxEssentials", + "agents", + "availableAgents" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke" + "query": [ + { + "description": "The organization ID of the customer or partner's organization.", + "key": "orgId", + "value": "" + }, + { + "description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.", + "key": "hasCxEssentials", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents?orgId=&hasCxEssentials=", + "variable": [ + { + "description": "Retrieve the list of avaiilable agents in this location.", + "key": "locationId", + "value": "" + } + ] } }, - "status": "Service Unavailable" + "status": "Gone" } ] - }, + } + ], + "name": "Features: Customer Assist" + }, + { + "item": [ { - "name": "Retrieve My Simultaneous Ring Settings", + "name": "Get Personal Assistant Settings", "request": { - "description": "Retrieve simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving settings requires a user auth token with a scope of `spark:telephony_config_read`.", + "description": "Retrieve personal assistant settings for a person. The personal assistant feature allows users to configure an automated attendant that can handle incoming calls when they are unavailable, including presence-based routing and call transfer options.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", "header": [ { "key": "Accept", @@ -829951,19 +848420,19 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 410, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -829977,20 +848446,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Unauthorized" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 405, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -830004,32 +848473,22 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"criteriasEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationRequiredEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationRequiredEnabled\": \"\"\n }\n ],\n \"criteria\": [\n {\n \"id\": \"\",\n \"source\": \"ALL_NUMBERS\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\"\n },\n {\n \"id\": \"\",\n \"source\": \"SPECIFIC_NUMBERS\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -830041,20 +848500,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "OK" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 504, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -830068,20 +848527,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 404, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -830095,20 +848554,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 423, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], "method": "GET", @@ -830122,20 +848581,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Bad Gateway" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 400, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -830149,20 +848608,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 502, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -830176,12 +848635,12 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Method Not Allowed" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -830203,9 +848662,9 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, "status": "Unsupported Media Type" @@ -830213,10 +848672,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -830230,22 +848689,32 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"enabled\": \"\",\n \"presence\": \"OUT_OF_OFFICE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"NONE\",\n \"alertMeFirstNumberOfRings\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -830257,20 +848726,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 428, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -830284,20 +848753,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Conflict" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 409, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -830311,12 +848780,12 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Gateway Timeout" + "status": "Conflict" }, { "_postman_previewlanguage": "text", @@ -830338,9 +848807,9 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, "status": "Internal Server Error" @@ -830348,10 +848817,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 403, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -830365,20 +848834,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 429, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -830392,17 +848861,17 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Precondition Required" + "status": "Too Many Requests" } ] }, { - "name": "Modify My Simultaneous Ring Settings", + "name": "Update Personal Assistant Settings", "request": { "body": { "mode": "raw", @@ -830412,9 +848881,9 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, - "description": "Modify simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying settings requires a user auth token with a scope of `spark:telephony_config_write`.", + "description": "Update personal assistant settings for a person. Allows configuring the personal assistant feature including enabling/disabling it, setting presence status, configuring call transfer options, and alerting preferences.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -830432,19 +848901,19 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 409, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -830454,7 +848923,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830473,20 +848942,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Bad Gateway" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 500, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -830496,7 +848965,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830515,20 +848984,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 405, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -830538,7 +849007,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830557,20 +849026,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Bad Request" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 204, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "No Content: Personal assistant settings successfully updated.", "originalRequest": { "body": { "mode": "raw", @@ -830580,7 +849049,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830599,20 +849068,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Internal Server Error" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 400, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -830622,7 +849091,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830641,20 +849110,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -830664,7 +849133,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830683,20 +849152,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 415, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -830706,7 +849175,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830725,20 +849194,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Method Not Allowed" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 428, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -830748,7 +849217,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830767,20 +849236,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Unsupported Media Type" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 502, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -830790,7 +849259,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830809,12 +849278,12 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", @@ -830832,7 +849301,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830851,9 +849320,9 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, "status": "Gateway Timeout" @@ -830861,10 +849330,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 423, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -830874,7 +849343,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830893,20 +849362,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Unauthorized" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 429, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -830916,7 +849385,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830935,20 +849404,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 503, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -830958,7 +849427,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -830977,20 +849446,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 404, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -831000,7 +849469,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -831019,20 +849488,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Gone" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 403, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -831042,7 +849511,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -831061,20 +849530,20 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 410, "cookie": [], "header": [], - "name": "No Content", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -831084,7 +849553,7 @@ "language": "json" } }, - "raw": "{\n \"enabled\": \"\",\n \"doNotRingIfOnCallEnabled\": \"\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"answerConfirmationEnabled\": \"\"\n }\n ],\n \"criteriasEnabled\": \"\"\n}" + "raw": "{\n \"enabled\": \"\",\n \"presence\": \"UNAVAILABLE\",\n \"untilDateTime\": \"\",\n \"transferEnabled\": \"\",\n \"transferNumber\": \"\",\n \"alerting\": \"PLAY_RING_REMINDER\",\n \"alertMeFirstNumberOfRings\": \"\"\n}" }, "header": [ { @@ -831103,19 +849572,19 @@ "people", "me", "settings", - "simultaneousRing" + "personalAssistant" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant" } }, - "status": "No Content" + "status": "Gone" } ] }, { - "name": "Retrieve My Simultaneous Ring Criteria", + "name": "Get Person's Voicemail Rules", "request": { - "description": "Retrieve simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving criteria requires a user auth token with a scope of `spark:telephony_config_read`.", + "description": "Get person's voicemail passcode rules. Voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.\n\nThe voicemail feature allows users to manage their voicemail settings as part of Webex Calling. Voicemail rules help ensure secure access to voice messages by defining passcode complexity requirements.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", "header": [ { "key": "Accept", @@ -831132,29 +849601,20 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 429, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -831167,30 +849627,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 410, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -831203,30 +849654,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Conflict" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 404, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -831239,42 +849681,23 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Unsupported Media Type" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"ringEnabled\": \"\",\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -831285,30 +849708,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -831321,30 +849735,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 405, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -831357,30 +849762,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Bad Gateway" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 502, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -831393,30 +849789,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Bad Request" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -831429,30 +849816,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 409, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -831465,30 +849843,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Gone" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 415, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -831501,30 +849870,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Internal Server Error" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 401, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -831537,22 +849897,13 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -831573,19 +849924,10 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, "status": "Gateway Timeout" @@ -831593,10 +849935,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 500, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], "method": "GET", @@ -831609,32 +849951,33 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Method Not Allowed" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 429, + "_postman_previewlanguage": "json", + "body": "{\n \"blockRepeatedPatternsEnabled\": \"\",\n \"blockUserNumberEnabled\": \"\",\n \"blockReversedUserNumberEnabled\": \"\",\n \"blockPreviousPasscodes\": {\n \"enabled\": \"\",\n \"numberOfPasscodes\": \"\"\n },\n \"blockReversedOldPasscodeEnabled\": \"\",\n \"blockRepeatedDigits\": {\n \"enabled\": \"\",\n \"max\": \"\"\n },\n \"blockContiguousSequences\": {\n \"enabled\": \"\",\n \"numberOfAscendingDigits\": \"\",\n \"numberOfDescendingDigits\": \"\"\n },\n \"length\": {\n \"min\": \"\",\n \"max\": \"\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -831645,30 +849988,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 423, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], "method": "GET", @@ -831681,30 +850015,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Precondition Required" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 428, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -831717,27 +850042,18 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "rules" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/rules" } }, - "status": "Service Unavailable" + "status": "Precondition Required" } ] }, { - "name": "Modify My Simultaneous Ring Criteria", + "name": "Update Voicemail PIN", "request": { "body": { "mode": "raw", @@ -831747,9 +850063,9 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, - "description": "Modify simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying criteria requires a user auth token with a scope of `spark:telephony_config_write`.", + "description": "Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply with the passcode rules defined for the organization.\n\nThe voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN. The PIN is required to retrieve voice messages via phone.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", "header": [ { "key": "Content-Type", @@ -831766,29 +850082,20 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 204, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "No Content: Voicemail PIN successfully updated.", "originalRequest": { "body": { "mode": "raw", @@ -831798,7 +850105,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -831816,30 +850123,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Method Not Allowed" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 410, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -831849,7 +850147,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -831867,30 +850165,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Forbidden" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 409, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -831900,7 +850189,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -831918,30 +850207,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Not Found" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 405, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -831951,7 +850231,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -831969,30 +850249,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Internal Server Error" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 504, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { "mode": "raw", @@ -832002,7 +850273,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832020,30 +850291,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 403, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -832053,7 +850315,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832071,30 +850333,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Gone" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 502, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -832104,7 +850357,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832122,30 +850375,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 401, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -832155,7 +850399,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832173,30 +850417,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -832206,7 +850441,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832224,30 +850459,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 400, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -832257,7 +850483,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832275,30 +850501,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Unsupported Media Type" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 415, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -832308,7 +850525,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832326,30 +850543,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Unauthorized" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 428, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -832359,7 +850567,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832377,30 +850585,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Bad Request" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 503, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -832410,7 +850609,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832428,30 +850627,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Conflict" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 429, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -832461,7 +850651,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832479,30 +850669,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 423, "cookie": [], "header": [], - "name": "No Content", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -832512,7 +850693,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832530,30 +850711,21 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "No Content" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 404, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -832563,7 +850735,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"PEOPLE\",\n \"callsFrom\": \"ANY_PHONE_NUMBER\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ],\n \"ringEnabled\": \"\"\n}" + "raw": "{\n \"passcode\": \"\"\n}" }, "header": [ { @@ -832581,31 +850753,27 @@ "config", "people", "me", - "settings", - "simultaneousRing", - "criteria", - ":id" + "voicemail", + "pin" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/voicemail/pin" } }, - "status": "Too Many Requests" + "status": "Not Found" } ] }, { - "name": "Delete My Simultaneous Ring Criteria", + "name": "Get Hoteling Guest Settings", "request": { - "description": "Delete simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nDeleting criteria requires a user auth token with a scope of `spark:telephony_config_write`.", - "header": [], - "method": "DELETE", + "description": "Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as a guest, associating their extension and configuration with that device for a limited time. This API returns the current hoteling guest configuration including any active host association details.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832616,31 +850784,23 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 428, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832651,32 +850811,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Service Unavailable" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 410, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832687,32 +850839,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Method Not Allowed" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 415, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832723,32 +850867,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 429, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832759,32 +850895,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 401, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832795,32 +850923,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Unsupported Media Type" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 404, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832831,32 +850951,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 403, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832867,32 +850979,34 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Precondition Required" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostAssociationLimitHours\": \"\",\n \"hostEnforcedAssociationLimitEnabled\": \"\",\n \"hostFirstName\": \"\",\n \"hostLastName\": \"\",\n \"hostId\": \"\",\n \"hostPhoneNumber\": \"\",\n \"hostExtension\": \"\",\n \"hostLocation\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832903,32 +851017,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 503, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832939,32 +851045,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Gateway Timeout" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 500, "cookie": [], "header": [], - "name": "No Content", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -832975,32 +851073,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "No Content" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 405, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833011,32 +851101,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Forbidden" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 504, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833047,32 +851129,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 502, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833083,32 +851157,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Not Found" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 423, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833119,32 +851185,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 400, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833155,32 +851213,24 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 409, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -833191,26 +851241,18 @@ "people", "me", "settings", - "simultaneousRing", - "criteria", - ":id" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id", - "variable": [ - { - "description": "Unique identifier for the criteria.", - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Conflict" } ] }, { - "name": "Create My Simultaneous Ring Criteria", + "name": "Update Hoteling Guest Settings", "request": { "body": { "mode": "raw", @@ -833220,20 +851262,16 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, - "description": "Create simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nCreating criteria requires a user auth token with a scope of `spark:telephony_config_write`.", + "description": "Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling as a guest, configuring whether an association will be removed automatically after a specified time period, and associating with a hoteling host.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`.", "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833244,20 +851282,20 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 423, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "body": { "mode": "raw", @@ -833267,7 +851305,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833275,7 +851313,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833286,21 +851324,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Conflict" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 400, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "body": { "mode": "raw", @@ -833310,7 +851348,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833318,7 +851356,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833329,21 +851367,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 401, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "body": { "mode": "raw", @@ -833353,7 +851391,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833361,7 +851399,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833372,21 +851410,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Precondition Required" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 405, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -833396,7 +851434,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833404,7 +851442,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833415,21 +851453,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Gone" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 502, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -833439,7 +851477,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833447,7 +851485,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833458,26 +851496,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Unauthorized" + "status": "Bad Gateway" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"id\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "body": { "mode": "raw", @@ -833487,19 +851520,15 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833510,21 +851539,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Created" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 504, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "body": { "mode": "raw", @@ -833534,7 +851563,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833542,7 +851571,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833553,21 +851582,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Unsupported Media Type" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 204, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "No Content: Hoteling guest settings successfully updated.", "originalRequest": { "body": { "mode": "raw", @@ -833577,7 +851606,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833585,7 +851614,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833596,21 +851625,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Bad Gateway" + "status": "No Content" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 415, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "body": { "mode": "raw", @@ -833620,7 +851649,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833628,7 +851657,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833639,21 +851668,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 428, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "body": { "mode": "raw", @@ -833663,7 +851692,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833671,7 +851700,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833682,21 +851711,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Gateway Timeout" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "body": { "mode": "raw", @@ -833706,7 +851735,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833714,7 +851743,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833725,21 +851754,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 410, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "body": { "mode": "raw", @@ -833749,7 +851778,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833757,7 +851786,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833768,21 +851797,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 409, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "body": { "mode": "raw", @@ -833792,7 +851821,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833800,7 +851829,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833811,21 +851840,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 429, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "body": { "mode": "raw", @@ -833835,7 +851864,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833843,7 +851872,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833854,21 +851883,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 404, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -833878,7 +851907,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833886,7 +851915,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833897,21 +851926,21 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 503, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "body": { "mode": "raw", @@ -833921,7 +851950,7 @@ "language": "json" } }, - "raw": "{\n \"scheduleName\": \"\",\n \"scheduleType\": \"businessHours\",\n \"scheduleLevel\": \"GROUP\",\n \"callsFrom\": \"SELECT_PHONE_NUMBERS\",\n \"ringEnabled\": \"\",\n \"anonymousCallersEnabled\": \"\",\n \"unavailableCallersEnabled\": \"\",\n \"phoneNumbers\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"enabled\": \"\",\n \"associationLimitEnabled\": \"\",\n \"associationLimitHours\": \"\",\n \"hostId\": \"\"\n}" }, "header": [ { @@ -833929,7 +851958,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -833940,20 +851969,20 @@ "people", "me", "settings", - "simultaneousRing", - "criteria" + "hoteling", + "guest" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria" + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest" } }, - "status": "Method Not Allowed" + "status": "Service Unavailable" } ] }, { - "name": "Retrieve My Guest Calling Numbers", + "name": "Get Available Hoteling Hosts", "request": { - "description": "Retrieve available guest calling numbers for the authenticated user.\n\nThis API returns a list of phone numbers that can be used for guest calling purposes.\n\nRetrieving guest calling numbers requires a user auth token with a scope of `spark:telephony_config_read`.", + "description": "Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by name or phone number and supports pagination.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`.", "header": [ { "key": "Accept", @@ -833971,20 +852000,42 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 429, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -833998,13 +852049,35 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Unsupported Media Type" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -834026,10 +852099,32 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, "status": "Unauthorized" @@ -834037,10 +852132,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 405, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -834054,23 +852149,55 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Service Unavailable" + "status": "Method Not Allowed" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"hosts\": [\n {\n \"hostId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"allowedAssociationDuration\": \"\"\n },\n {\n \"hostId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phoneNumber\": \"\",\n \"extension\": \"\",\n \"allowedAssociationDuration\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -834082,33 +852209,45 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Precondition Required" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"\",\n \"state\": \"ACTIVE\",\n \"isMainNumber\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"state\": \"ACTIVE\",\n \"isMainNumber\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -834120,21 +852259,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "OK" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 500, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], "method": "GET", @@ -834148,21 +852309,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Gone" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 403, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -834176,21 +852359,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 400, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -834204,21 +852409,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 428, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -834232,21 +852459,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Method Not Allowed" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 503, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -834260,13 +852509,35 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -834288,10 +852559,32 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, "status": "Conflict" @@ -834299,10 +852592,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 415, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -834316,21 +852609,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 404, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -834344,21 +852659,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 423, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], "method": "GET", @@ -834372,21 +852709,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Not Found" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 410, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -834400,21 +852759,43 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Forbidden" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 504, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -834428,18 +852809,40 @@ "people", "me", "settings", - "guestCalling", - "numbers" + "hoteling", + "availableHosts" ], - "raw": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers" + "query": [ + { + "description": "Limit the maximum number of hosts in the response. Default is 100.", + "key": "max", + "value": "2000" + }, + { + "description": "Start index for pagination. Default is 0.", + "key": "start", + "value": "0" + }, + { + "description": "Filter hosts by name (first name or last name). Partial match is supported.", + "key": "name", + "value": "" + }, + { + "description": "Filter hosts by phone number. Partial match is supported.", + "key": "phoneNumber", + "value": "" + } + ], + "raw": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts?max=2000&start=0&name=&phoneNumber=" } }, - "status": "Bad Gateway" + "status": "Gateway Timeout" } ] } ], - "name": "Call Settings For Me Phase 4" + "name": "Call Settings For Me Phase 5" }, { "name": "Read the Contact Center Extensions", diff --git a/codegen/postman/Webex Contact Center.postman_collection.json b/codegen/postman/Webex Contact Center.postman_collection.json index 643da1a..6c8dcc1 100644 --- a/codegen/postman/Webex Contact Center.postman_collection.json +++ b/codegen/postman/Webex Contact Center.postman_collection.json @@ -647,7 +647,7 @@ { "name": "Get specific Agent Burnout resource by ID", "request": { - "description": "Retrieve an existing Agent Burnout resource by ID in a given organization.", + "description": "Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead.", "header": [ { "key": "Accept", @@ -964,9 +964,9 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update an existing Agent Burnout resource by ID in a given organization.", + "description": "Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead.", "header": [ { "key": "Content-Type", @@ -1025,7 +1025,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1084,7 +1084,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1143,7 +1143,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1202,7 +1202,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1261,7 +1261,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1320,7 +1320,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1379,7 +1379,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1438,7 +1438,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\"\n}" + "raw": "{\n \"agentInclusionType\": \"SPECIFIC\",\n \"enabled\": \"\",\n \"organizationId\": \"BE7Ae0fbD2ccBa4f-8beC-BcdabbB2eccC\",\n \"id\": \"\",\n \"version\": \"\",\n \"wellnessBreakReminders\": \"ENABLED\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -1481,7 +1481,7 @@ { "name": "List Agent Burnout resource(s)", "request": { - "description": "Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource.", + "description": "Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource. Deprecated. Use GET /v2/ai-feature/agent-burnout instead.", "header": [ { "key": "Accept", @@ -1501,12 +1501,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1564,12 +1564,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1627,12 +1627,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1690,12 +1690,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1753,12 +1753,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1816,12 +1816,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1879,12 +1879,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -1928,9 +1928,9 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Create a new Auto CSAT mapped Question in a given organization.", + "description": "Create a new Auto CSAT mapped Question in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question instead.", "header": [ { "key": "Content-Type", @@ -1990,7 +1990,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2050,7 +2050,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2110,7 +2110,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2170,7 +2170,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2230,7 +2230,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2290,7 +2290,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2350,7 +2350,7 @@ "language": "json" } }, - "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"d88A24A6-D3eAa9e4BA1f-8b9C525a4B85\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -2404,7 +2404,7 @@ }, "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"f7C43EB6-7919578d-Aca9B7dD3e2eE5c7\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"23d6e73F-caeB-2FdFa51A-4e1beEAEe879\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization.", + "description": "Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question/bulk instead.", "header": [ { "key": "Content-Type", @@ -2876,7 +2876,7 @@ { "name": "Get specific Auto CSAT mapped Question by ID", "request": { - "description": "Retrieve an existing Auto CSAT mapped Question by ID in a given organization.", + "description": "Retrieve an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/question/{id} instead.", "header": [ { "key": "Accept", @@ -3228,7 +3228,7 @@ { "name": "Delete specific Auto CSAT mapped Question by ID", "request": { - "description": "Delete an existing Auto CSAT mapped Question by ID in a given organization.", + "description": "Delete an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use DELETE /ai-feature/auto-csat/question/{id} instead.", "header": [ { "key": "Accept", @@ -3621,7 +3621,7 @@ { "name": "Get specific Auto CSAT resource by ID", "request": { - "description": "Retrieve an existing Auto CSAT resource by ID in a given organization.", + "description": "Retrieve an existing Auto CSAT resource by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/{id} instead.", "header": [ { "key": "Accept", @@ -3938,9 +3938,9 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update an existing Auto CSAT resource by ID in a given organization.", + "description": "Update an existing Auto CSAT resource by ID in a given organization. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead.", "header": [ { "key": "Content-Type", @@ -3999,7 +3999,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4058,7 +4058,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4117,7 +4117,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4176,7 +4176,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4235,7 +4235,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4294,7 +4294,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4353,7 +4353,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4412,7 +4412,7 @@ "language": "json" } }, - "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"agentInclusionType\": \"ALL\",\n \"enabled\": \"\",\n \"selectedGlobalVariableId\": \"\",\n \"surveyDataSource\": \"GLOBAL_VARIABLE\",\n \"organizationId\": \"5ACaA01E-4112bD790A3F8bc0Ad77Efe7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -4455,7 +4455,7 @@ { "name": "List Auto CSAT resource(s)", "request": { - "description": "Retrieve a list of Auto CSAT resource(s) in a given organization.Only one entry per organization can exist for Auto CSAT resource.", + "description": "Retrieve a list of Auto CSAT resource(s) in a given organization.Only one entry per organization can exist for Auto CSAT resource. Deprecated. Use GET /v2/ai-feature/auto-csat instead.", "header": [ { "key": "Accept", @@ -4475,12 +4475,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4538,12 +4538,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4601,12 +4601,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4664,12 +4664,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4727,12 +4727,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4790,12 +4790,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4853,12 +4853,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -4889,7 +4889,7 @@ { "name": "List Auto CSAT mapped Question(s)", "request": { - "description": "Retrieve a list of Auto CSAT mapped Question(s) in a given organization.", + "description": "Retrieve a list of Auto CSAT mapped Question(s) in a given organization. Deprecated. Use GET /v2/ai-feature/auto-csat/question instead.", "header": [ { "key": "Accept", @@ -4911,12 +4911,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -4981,12 +4981,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5018,7 +5018,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"bEF381cEd42F-eca585Cec8cb7Fc1D6Fb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"c0BBaBb64CC0-1a34D055-C53EcBc1F60D\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 2564.9912264745376,\n \"key_2\": 3558\n },\n \"data\": [\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"bEF381cEd42F-eca585Cec8cb7Fc1D6Fb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"questionId\": \"\",\n \"questionnaireId\": \"\",\n \"organizationId\": \"c0BBaBb64CC0-1a34D055-C53EcBc1F60D\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -5050,12 +5050,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5119,12 +5119,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5188,12 +5188,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5257,12 +5257,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5326,12 +5326,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported(id, questionId, questionnaireId)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.(id, questionId, questionnaireId)", "key": "attributes", "value": "" }, @@ -5371,7 +5371,7 @@ { "name": "Get specific Generated Summaries resource by ID", "request": { - "description": "Retrieve an existing Generated Summaries resource by ID in a given organization.", + "description": "Retrieve an existing Generated Summaries resource by ID in a given organization. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead.", "header": [ { "key": "Accept", @@ -5688,9 +5688,9 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update an existing Generated Summaries resource by ID in a given organization.", + "description": "Update an existing Generated Summaries resource by ID in a given organization. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead.", "header": [ { "key": "Content-Type", @@ -5749,7 +5749,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -5808,7 +5808,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -5867,7 +5867,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -5926,7 +5926,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -5985,7 +5985,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -6044,7 +6044,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -6103,7 +6103,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -6162,7 +6162,7 @@ "language": "json" } }, - "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\"\n}" + "raw": "{\n \"organizationId\": \"97e45edbf9dF-bc5A-97fA1FDbF46aaAFb\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -6205,7 +6205,7 @@ { "name": "List Generated Summaries resource(s)", "request": { - "description": "Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries resource.", + "description": "Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries resource. Deprecated. Use GET /v2/ai-feature/generated-summaries instead.", "header": [ { "key": "Accept", @@ -6225,12 +6225,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6288,12 +6288,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6351,12 +6351,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6414,12 +6414,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6477,12 +6477,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6540,12 +6540,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6573,7 +6573,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"F0eE76139F47-21e3B4da39B46B354f25\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"3Cf5E861-25936e9D-4caEbBb82DE1D073\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"SPECIFIC\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"orgid\": \"\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n }\n },\n \"data\": [\n {\n \"organizationId\": \"F0eE76139F47-21e3B4da39B46B354f25\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"ALL\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"3Cf5E861-25936e9D-4caEbBb82DE1D073\",\n \"id\": \"\",\n \"version\": \"\",\n \"callDropSummariesEnabled\": \"\",\n \"virtualAgentTransferSummariesEnabled\": \"\",\n \"consultTransferSummariesEnabled\": \"\",\n \"agentInclusionType\": \"SPECIFIC\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -6603,12 +6603,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, @@ -6663,12 +6663,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -6730,12 +6730,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -6768,7 +6768,7 @@ }, { "_postman_previewlanguage": "text", - "body": "[\n {\n \"name\": \"AHX8goPmUxINLDNolqHZD\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"FRI\"\n ],\n \"name\": \"qaomfEE1\u200ataX8SKm9\u205fWneCbdlmzN0\u2005D9nfm6X\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"WED\",\n \"THU\"\n ],\n \"name\": \"xEOdGmoAx\u2004ghFj\\fln02-zm\\r_ivVZ\u20094d\u2005zwDGe20V\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"C34a75Bf-Db0B-DDe5-d5Ae-b8322B2d814b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"JlTOPLxeblz8n1\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"SAT\"\n ],\n \"name\": \"0MmJNFua\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"DtwE6biu_\u2003zAlOIMeFck\u2000u\u205fgDQiQp\u2001WdjL\u2004IH1wiNpudlH\\ncVWOh60O\u20078\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"0F5eAf51-8dEd-51d5fe69aD88FfDaF806\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"organizationId\": \"e04Fe2CA5BA95e522AFc-03BbfA385AEB\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"qGFG_zv5iHlI3fHeQ7id\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"13F20C12339C711a-018A-e9edB5e6ebc2\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"9\ufeffga7Ra3TwS5\u2006Epyr\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -6797,12 +6797,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -6864,12 +6864,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -6931,12 +6931,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -6998,12 +6998,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -7065,12 +7065,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -7114,7 +7114,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Business Hours resource in a given organization.", "header": [ @@ -7169,7 +7169,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7223,7 +7223,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7277,7 +7277,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7331,7 +7331,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7385,7 +7385,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7439,7 +7439,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -7493,7 +7493,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -8645,7 +8645,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Business Hours resource by ID in a given organization.", "header": [ @@ -8706,7 +8706,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -8765,7 +8765,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -8824,7 +8824,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -8883,7 +8883,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -8942,7 +8942,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -9001,7 +9001,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -9060,7 +9060,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -9119,7 +9119,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\"\n}" + "raw": "{\n \"name\": \"Cr24930eHx7\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"WED\",\n \"MON\"\n ],\n \"name\": \"ameuEYlRbOY1zoKVVXc7nyq3qGfkQy3_m\u202fJ9u0E\\rLsopOu-lzR\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"SUN\",\n \"FRI\"\n ],\n \"name\": \"1ZyD60\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"3E1Fa44E-eb1AdAdf3A221fA2baed6EB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -9961,12 +9961,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10014,7 +10014,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"name\": \"uQMwRU5kkMQhRjM44\u2005ncULCBiAYtIY\u2003y\u30003zW\u2009Ila\u202fsG\u2028Awn6dYkAyi\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"FRI\",\n \"WED\"\n ],\n \"name\": \"a_i3aEBZqHThk\u20099FsmF1qkPTphoLN4LXBJZ-IClTy\u2029D-o\u00a0fDGt09c\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"MON\",\n \"WED\"\n ],\n \"name\": \"MCke7WReAaPL7DeaLcDh\u202fU2hL\u2028f7rDlCW\u2001xsuMJusj0\u1680nt7mfXEEMH3C3\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"cb37Ba7B-9aBaFFc425b88395c85c3FCd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"eM8v\u20069g\u30003AQLck\u205f-uQ3gSJq\u200aAKG\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"SAT\",\n \"TUE\"\n ],\n \"name\": \"pmZ\u202fwtnejhQHOMcb5lz2H\u2007Gk\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"WED\",\n \"FRI\"\n ],\n \"name\": \"DEtVuM8FD6ZU8I2dB7x\u2006TzU_\u180enOUe0z45\u2006-s5Yk\\f2r\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"9eA4Aadc-8323412F-46AE-DDb9aecbdfFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"name\": \"uQMwRU5kkMQhRjM44\u2005ncULCBiAYtIY\u2003y\u30003zW\u2009Ila\u202fsG\u2028Awn6dYkAyi\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"FRI\",\n \"WED\"\n ],\n \"name\": \"a_i3aEBZqHThk\u20099FsmF1qkPTphoLN4LXBJZ-IClTy\u2029D-o\u00a0fDGt09c\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"MON\",\n \"WED\"\n ],\n \"name\": \"MCke7WReAaPL7DeaLcDh\u202fU2hL\u2028f7rDlCW\u2001xsuMJusj0\u1680nt7mfXEEMH3C3\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"cb37Ba7B-9aBaFFc425b88395c85c3FCd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"eM8v\u20069g\u30003AQLck\u205f-uQ3gSJq\u200aAKG\",\n \"timezone\": \"\",\n \"workingHours\": [\n {\n \"days\": [\n \"SAT\",\n \"TUE\"\n ],\n \"name\": \"pmZ\u202fwtnejhQHOMcb5lz2H\u2007Gk\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"days\": [\n \"WED\",\n \"FRI\"\n ],\n \"name\": \"DEtVuM8FD6ZU8I2dB7x\u2006TzU_\u180enOUe0z45\u2006-s5Yk\\f2r\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ],\n \"organizationId\": \"9eA4Aadc-8323412F-46AE-DDb9aecbdfFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysId\": \"\",\n \"overridesId\": \"\",\n \"workingHoursCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -10044,12 +10044,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10127,12 +10127,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10210,12 +10210,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10293,12 +10293,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10376,12 +10376,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10459,12 +10459,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, workingHours, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (workingHours)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)", "key": "attributes", "value": "" }, @@ -10539,12 +10539,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10606,12 +10606,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10673,12 +10673,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10711,7 +10711,7 @@ }, { "_postman_previewlanguage": "text", - "body": "[\n {\n \"holidays\": [\n {\n \"name\": \"Gp_ylMWm72\\rN_qPi9YNO\u20072\u20027dZ5nWJ\u2001BxMIVauZcqF\\fj_wsy\u2008gww\u180eazr1At\u2004SQh\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"lNBAITv\u2002K3NPsdi9ioGS37nyI9BA\\u000bunu5VeO\\u000boysfAsBkq57lTpP2iTF\u2005m\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"p7-Wm1phP1Ts\u1680KyvM7O\",\n \"organizationId\": \"DadbDb1E6b70fdDa04aF55F5BfdcbFeD\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"holidays\": [\n {\n \"name\": \"nCcRJEch9NSixxOFc\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"co0AZi\u2007cM8fKwRI\u2008MCOIbNGuN\u2003t1vpcxF\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"P\u2007bbN8JCWJ\u2004j2DRQl-29jw5dFN8wQT2OS5RStx\",\n \"organizationId\": \"8D4B2F5B-a3cb-F0C68f5b-E7BFcc90bF08\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"organizationId\": \"6c25DFd754CE3673-6ca806AFe3Ed50b5\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"g\u2009dNIvDtq\u00a0BJfmaALM3zr0o\u20060v91wYuR9_IXL\u2000PqN\u2001_UlMf\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"E14Eed2adDCaed330d6f4E7FCB548BC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"Fjtb2NKQ\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -10740,12 +10740,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10807,12 +10807,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10874,12 +10874,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10941,12 +10941,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -10990,7 +10990,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Holiday List in a given organization.", "header": [ @@ -11045,7 +11045,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11099,7 +11099,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11153,7 +11153,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11207,7 +11207,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11261,7 +11261,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11315,7 +11315,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -11369,7 +11369,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12521,7 +12521,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Holiday List by ID in a given organization.", "header": [ @@ -12582,7 +12582,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12641,7 +12641,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12700,7 +12700,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12759,7 +12759,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12818,7 +12818,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12877,7 +12877,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12936,7 +12936,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -12995,7 +12995,7 @@ "language": "json" } }, - "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\"\n}" + "raw": "{\n \"holidays\": [\n {\n \"name\": \"3l-z1TXGw\u1680YViM\u20040v2sGNcaGlSo\\u000b4-Ov2HcE8o2vO1DDenkIer\\npd2-DoJSN\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"atJ jObtKgkb7Wd5emoNkHGb\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"cMM0J_3\u2028-l\",\n \"organizationId\": \"5EEbfc6CAcA3-6522-F8c45a8d7fe7fC52\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -13837,12 +13837,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -13920,12 +13920,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14003,12 +14003,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14086,12 +14086,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14169,12 +14169,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14222,7 +14222,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"holidays\": [\n {\n \"name\": \"mrP_opmfM0V2Ol2E\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"yMSVgM tL6o28_\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"XsjlAKQGEj\u2001NqlFYjRHDuBEXcMbxsZotVqUf5YKLFlsemMpXUC8ffrueO93wpIzM8ssFfw\",\n \"organizationId\": \"ab3d0876-E0A5-54aAb80497BbDaBF2A3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"holidays\": [\n {\n \"name\": \"-0ebFClgxV\u2002CWkDh2pk\u3000PwcY\u2006B0t70BhQo4VvgbJk-gcu\\rTz40\u20065XVF\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"G9rw5\u2009ECngGmvt6GBCTn_\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"oSEHKQW3mOoBxDimeoTK\u2028dSXKMVZ43\",\n \"organizationId\": \"1ccC857a-fE5Ed6c4C4da-1ad4eCE025EE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": false\n },\n \"data\": [\n {\n \"holidays\": [\n {\n \"name\": \"mrP_opmfM0V2Ol2E\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"yMSVgM tL6o28_\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"XsjlAKQGEj\u2001NqlFYjRHDuBEXcMbxsZotVqUf5YKLFlsemMpXUC8ffrueO93wpIzM8ssFfw\",\n \"organizationId\": \"ab3d0876-E0A5-54aAb80497BbDaBF2A3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"holidays\": [\n {\n \"name\": \"-0ebFClgxV\u2002CWkDh2pk\u3000PwcY\u2006B0t70BhQo4VvgbJk-gcu\\rTz40\u20065XVF\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"name\": \"G9rw5\u2009ECngGmvt6GBCTn_\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ],\n \"name\": \"oSEHKQW3mOoBxDimeoTK\u2028dSXKMVZ43\",\n \"organizationId\": \"1ccC857a-fE5Ed6c4C4da-1ad4eCE025EE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"holidaysCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -14252,12 +14252,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14335,12 +14335,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, holidays, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except holidays", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays", "key": "attributes", "value": "" }, @@ -14415,12 +14415,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14482,12 +14482,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14520,7 +14520,7 @@ }, { "_postman_previewlanguage": "text", - "body": "[\n {\n \"name\": \"TjpUNvuCbouZ\u2004PIyb\",\n \"overrides\": [\n {\n \"name\": \"GGOBzmMhit7kFgqWCVTH0YD_YY\\u000bwIb\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"yR-l9WOuu\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"6Bba7280-5ffE-F3EA5444C23a9F04f9a8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"lg29p\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"1smNG\\u000bRYKLRyF\",\n \"overrides\": [\n {\n \"name\": \"NaSg\u2005qxBgvapHrJvXvFuvmKd1LSEJ\u20038pghL3JV0BJMD3YmhnaLyY7r\u2005H1OACtm\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ClszEGnh\u2003RLjR6FhONuwF\u205fY4V\\u000bD0LzCM\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"d6af9fd70eEf959A-0Dbf-CF012daD51E7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"sVqYLz12V\\u000beNK8BrtJel3RhHED_p9\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"organizationId\": \"cDDaFe97-aef8-2cD6-06b9d8e2Fa60ad9D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"9KS\u2008-s2PegasXQX5mCw\u2006_qhzW\u1680lVQ\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"latestOverride\": {\n \"name\": \"cvdD5MZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"Weekly\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"SECOND\",\n \"daysOfWeek\": [\n \"SUN\",\n \"THU\",\n \"THU\",\n \"WED\",\n \"SAT\",\n \"SAT\",\n \"SAT\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"AUG\",\n \"endDate\": \"5440-50-73\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"37F02629A364B4CC-acc7-C695b4fb09ab\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"oFa\u2007LiUkiVwBWoMKGXHBQ2_3koDQawn\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"latestOverride\": {\n \"name\": \"WzOSnyKZ\u20024d2b6aOBwJksluDl8p30Q\u2008wNr48m6xCMFOc\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"Monthly\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FIRST\",\n \"daysOfWeek\": [\n \"SAT\",\n \"TUE\",\n \"SUN\",\n \"FRI\",\n \"THU\",\n \"FRI\",\n \"WED\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"MAR\",\n \"endDate\": \"4465-31-55\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -14549,12 +14549,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14616,12 +14616,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14683,12 +14683,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14750,12 +14750,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14817,12 +14817,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -14866,7 +14866,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Overrides resource in a given organization.", "header": [ @@ -14921,7 +14921,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -14956,7 +14956,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -14975,7 +14975,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -15029,7 +15029,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -15083,7 +15083,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -15137,7 +15137,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -15191,7 +15191,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -15245,7 +15245,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16341,7 +16341,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -16397,7 +16397,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Overrides resource by ID in a given organization.", "header": [ @@ -16458,7 +16458,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16517,7 +16517,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16557,7 +16557,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"name\": \"NUN33qzvXKoHTEp\",\n \"overrides\": [\n {\n \"name\": \"3stB5Oz\u20085O\u20067E134 GZhJIHWzAPb6WxUprky\u3000d\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"ORurIg\u30006QV8ESS9FQwEvcgRr0\u2008v7-9-Z9J\u2000hkAnC\u200aj27g4mG-0NlYc4Bp\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"058dedF2-D8445151fFa3-905c3acD5De9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"7bKzS\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -16576,7 +16576,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16635,7 +16635,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16694,7 +16694,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16753,7 +16753,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16812,7 +16812,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -16871,7 +16871,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n}" + "raw": "{\n \"name\": \"sxkm_0C01ap5\u2002A\\rn78Jx5L0\u300080c9at\u200ajwBLB0\u200afXT_-O4vTG\u2006fioUyP4IWW0E0JZ\",\n \"overrides\": [\n {\n \"name\": \"CwUeQ-MZJZI\u200ap3ds1\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"znZDuCRJw9\\nwqJDTS-0VEE5\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"Ed8DBffbc134-A026DfCD-dcBe24FFe1eF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"Dmz\u2008fZ\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"frequency\": \"DontRepeat\",\n \"recurrence\": {\n \"interval\": \"\",\n \"occurrenceInTheMonth\": \"FOURTH\",\n \"daysOfWeek\": [\n \"MON\",\n \"THU\",\n \"SAT\",\n \"SUN\",\n \"MON\",\n \"TUE\",\n \"THU\"\n ],\n \"specificDayOfMonth\": \"\",\n \"specificMonth\": \"JUL\",\n \"endDate\": \"9544-14-72\"\n }\n },\n \"overridesCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -17713,12 +17713,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -17766,7 +17766,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"name\": \"annm\u202feld120_Erm\u2004OO7iYfo\u2009KHpYrfUK\",\n \"overrides\": [\n {\n \"name\": \"VRzqB4chZThNEyIICB\u2029dztrA\u200898qlZP\u00a0HPuAMiH\u2000RklZA1H-ZnfGl\u2002p\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"pnen38\\nrPxiwM1T\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"FBBFd0460B7e18ED-5D2C7FebAeBf370a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"nEuJz88d4Dxg KwS\u20295Iq\u2003gfiu5MdMA-\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"YfzMz1uzAEnGm0h2HRaO3A08ZvOBVYFLrGIn\u202fewcTNXT82qB\u2009VkPlxnBWI\ufefflZHVY4FpfvDojiD0yV\u00a0PG\",\n \"overrides\": [\n {\n \"name\": \"dwthzrJ9N\u2004IN6xYibpy9tGl1ji\u2002EV1vsJ\u00a0Y6Drr 5\\r2-Z5hejUVrU8_xX\u2006FnQ\\nh4\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"1p\u2005KldEBkbK0M36\u2028UmJzIEhXsAfmizq-4JPDFM7NwOwDV2Z9u\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"b955b6fB-0AAEe2EA-3c6db1F5eFD064c8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"XrQf\\tB4CpgI1woU\u2002d\\rmZKSwcyP\u202fv5jOAVOIzBHenp-u3b\u202fshgmPdMw7Y\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"name\": \"annm\u202feld120_Erm\u2004OO7iYfo\u2009KHpYrfUK\",\n \"overrides\": [\n {\n \"name\": \"VRzqB4chZThNEyIICB\u2029dztrA\u200898qlZP\u00a0HPuAMiH\u2000RklZA1H-ZnfGl\u2002p\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"pnen38\\nrPxiwM1T\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"FBBFd0460B7e18ED-5D2C7FebAeBf370a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"nEuJz88d4Dxg KwS\u20295Iq\u2003gfiu5MdMA-\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"YfzMz1uzAEnGm0h2HRaO3A08ZvOBVYFLrGIn\u202fewcTNXT82qB\u2009VkPlxnBWI\ufefflZHVY4FpfvDojiD0yV\u00a0PG\",\n \"overrides\": [\n {\n \"name\": \"dwthzrJ9N\u2004IN6xYibpy9tGl1ji\u2002EV1vsJ\u00a0Y6Drr 5\\r2-Z5hejUVrU8_xX\u2006FnQ\\nh4\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n {\n \"name\": \"1p\u2005KldEBkbK0M36\u2028UmJzIEhXsAfmizq-4JPDFM7NwOwDV2Z9u\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n }\n ],\n \"timezone\": \"\",\n \"organizationId\": \"b955b6fB-0AAEe2EA-3c6db1F5eFD064c8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"latestOverride\": {\n \"name\": \"XrQf\\tB4CpgI1woU\u2002d\\rmZKSwcyP\u202fv5jOAVOIzBHenp-u3b\u202fshgmPdMw7Y\",\n \"workingHours\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -17796,12 +17796,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -17879,12 +17879,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -17962,12 +17962,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -18045,12 +18045,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -18128,12 +18128,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -18211,12 +18211,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, overrides, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (overrides)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)", "key": "attributes", "value": "" }, @@ -18324,7 +18324,7 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "[\n {\n \"name\": \"\u2002\u2006L_Ku0T\\r\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"ceA5DA5d263ADE5B-a27f-E3aeBcB321d1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"\u1680O4o\ufeff7r\u00a0v\",\n \"number\": \"26\",\n \"organizationId\": \"B4d4161DABec-21EF-1f9F-44F91497CB52\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u3000\\riLD\",\n \"number\": \"+6457760-9\",\n \"organizationId\": \"dcE373cf-08c5-FB79-cf1F-0b37B3FC1f86\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2004HYl\\f\\rE\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"acEf1fdd-5AbA-53Ea-20dCF8ED1d81C49B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\u20280A\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"dac\u2001p\\t53\",\n \"number\": \"-363+3\",\n \"organizationId\": \"AFA2C5F2-cB81139C1FA65Cb9CDe4F5D9\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\ufeff9\\nVrSp\",\n \"number\": \"403)296+\",\n \"organizationId\": \"Bae97baD-A07F-BCD229D0B91ce1F8cF43\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"name\": \"G\u20034NtK\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"f1e61Ea4-bbf2-8C9A-cA45cdf61a8F865B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"udgp\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"\",\n \"number\": \"0\",\n \"organizationId\": \"959DFD8cCc11cAF5eAD3-AA8E6AdAab05\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2009\u2029Y\",\n \"number\": \"7\",\n \"organizationId\": \"d9DdB3FeaAEd-08fF560212Acd5c46edA\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"t\u2000\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"Bf1f6b0E-A8ab-60d0-cCFC-D5e3dc4a02Fd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\u2005M\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"LGU\",\n \"number\": \"2(97\",\n \"organizationId\": \"3e6fB2c0-CFE1CDf3e3B3-5bE0D244dBFA\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"LcD\",\n \"number\": \"(\",\n \"organizationId\": \"Ccba113E-27BE-12ae0Cd88CE7adDdC79b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -23712,7 +23712,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"name\": \"TTGN\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"f8dEFc0B-F1C5e1DE-B560-a1ae33f48E4A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"s\u2002Kqg\u2004\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"ksE\u2003\",\n \"number\": \"11-0)35\",\n \"organizationId\": \"39cf88B1-aF9e-bE68-eDDCB7ED15970bfc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"1\u3000\u180eUL\u1680h\",\n \"number\": \")774--26)4\",\n \"organizationId\": \"c8FBe61B2B5bd332-C990-d343504EE7Da\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"..\u202f\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"c38a332b483fce6e7feC3bcD4A1B947f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"T\\fxbG\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"mh\",\n \"number\": \"710105\",\n \"organizationId\": \"E6d69c59a04bA71757dA-B3Bee2fBafFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2001\",\n \"number\": \")001\",\n \"organizationId\": \"c66e4Ef21E5Ab87FC6ED29150dC959dc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"name\": \"TTGN\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"f8dEFc0B-F1C5e1DE-B560-a1ae33f48E4A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"s\u2002Kqg\u2004\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"ksE\u2003\",\n \"number\": \"11-0)35\",\n \"organizationId\": \"39cf88B1-aF9e-bE68-eDDCB7ED15970bfc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"1\u3000\u180eUL\u1680h\",\n \"number\": \")774--26)4\",\n \"organizationId\": \"c8FBe61B2B5bd332-C990-d343504EE7Da\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"..\u202f\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"c38a332b483fce6e7feC3bcD4A1B947f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"T\\fxbG\",\n \"siteId\": \"\",\n \"addressBookEntries\": [\n {\n \"name\": \"mh\",\n \"number\": \"710105\",\n \"organizationId\": \"E6d69c59a04bA71757dA-B3Bee2fBafFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2001\",\n \"number\": \")001\",\n \"organizationId\": \"c66e4Ef21E5Ab87FC6ED29150dC959dc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -24693,7 +24693,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"name\": \"n\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"4518eE269AFd-5be2-2faadD4Fb62dCe8d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"X\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"bC780b90d74A1e336e51e372beDbD09e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"name\": \"n\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"4518eE269AFd-5be2-2faadD4Fb62dCe8d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"X\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"bC780b90d74A1e336e51e372beDbD09e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -29287,7 +29287,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"contentType\": \"TEXT_PHP\",\n \"name\": \"F\u205f\u2009.k\",\n \"organizationId\": \"D812F2Fe1d2D1bdEB57e-53cC15Cd50AC\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"contentType\": \"AUDIO_WAV\",\n \"name\": \"zn8E\",\n \"organizationId\": \"A07aa9eA-5FffFF2A23cdE043fDEb16Cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"contentType\": \"TEXT_PHP\",\n \"name\": \"F\u205f\u2009.k\",\n \"organizationId\": \"D812F2Fe1d2D1bdEB57e-53cC15Cd50AC\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"contentType\": \"AUDIO_WAV\",\n \"name\": \"zn8E\",\n \"organizationId\": \"A07aa9eA-5FffFF2A23cdE043fDEb16Cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"blobId\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"audioFile\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -29551,7 +29551,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"\",\n \"workTypeCode\": \"IDLE_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"bF499aaEdaB65c174ffF-eFfd22091E98\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"isSystemCode\": \"\",\n \"burnoutInclusion\": \"EXCLUDED\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"\u2001\u3000dV\u2003u\",\n \"workTypeCode\": \"WRAP_UP_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"Be685bCF-0acF-f5eb-4bBE487dEbDdE77F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"isSystemCode\": \"\",\n \"burnoutInclusion\": \"INCLUDED\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"gGow\",\n \"workTypeCode\": \"IDLE_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"3CC660cc-ECB5F5dc-Cb40-cBac913D3cBA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"isSystemCode\": \"\",\n \"burnoutInclusion\": \"INCLUDED\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"defaultCode\": \"\",\n \"name\": \"\",\n \"workTypeCode\": \"WRAP_UP_CODE\",\n \"workTypeId\": \"\",\n \"organizationId\": \"fEdA784a573DF4B3-87b4-D1F55700c6E2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"isSystemCode\": \"\",\n \"burnoutInclusion\": \"NOT_APPLICABLE\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -31619,7 +31619,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -37288,7 +37288,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37298,12 +37298,7 @@ "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37323,7 +37318,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue?filter=&channelTypes=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -37365,7 +37360,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37375,7 +37370,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37437,7 +37432,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37447,7 +37442,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37509,7 +37504,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37519,7 +37514,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37581,7 +37576,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37591,7 +37586,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37653,7 +37648,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37663,7 +37658,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37696,7 +37691,7 @@ }, { "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"EMAIL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"euC\\ruJ\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"D7Fbf28bBB68A0ac-16EB71BB0CDA4c9a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSENGER\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"56754\",\n \"vendorId\": \"7m1f_q\u2001\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"50b4b26b-B6cA-3fF6b93F-3DE9e9c66Cc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"eC42d96F28aD-90f5-602Eb8ee3ccfddE8\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"FAX\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"fYq\u1680muymmI\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LINEAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"C6ffdc8b-2e42-bb8A-3CA1-74eBF6e1A40f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"964\",\n \"vendorId\": \"fWES\u3000Z\\t\u20068Z\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F6aB378c07d3-66F04ccF68e5d494053E\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2F6Bf34-6bf1203C8c58cCbb9f3A366A\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "[\n {\n \"organizationId\": \"eD60D7fab1aaB51dF256-D171E515CB6d\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"queueType\": \"OUTBOUND\",\n \"checkAgentAvailability\": \"\",\n \"channelType\": \"CHAT\",\n \"socialChannelType\": \"APPLE_BUSINESS_CHAT\",\n \"serviceLevelThreshold\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"active\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"eadEC3DA-07CB-a7DF-1c639b00AAABd0EF\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"queueType\": \"OUTBOUND\",\n \"checkAgentAvailability\": \"\",\n \"channelType\": \"WORK_ITEM\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"serviceLevelThreshold\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"active\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"skillBasedRoutingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -37725,7 +37720,7 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, @@ -37735,7 +37730,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -37779,7 +37774,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Contact Service Queue in a given organization.", "header": [ @@ -37834,7 +37829,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -37869,7 +37864,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -37888,7 +37883,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -37942,7 +37937,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -37996,7 +37991,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -38050,7 +38045,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -38104,7 +38099,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -38158,7 +38153,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -39459,9 +39454,9 @@ ] }, { - "name": "Get specific By skill profile ID", + "name": "List Skill CSQs by Skill Profile", "request": { - "description": "Retrieve an existing Contact Service Queue by skill profile ID in a given organization.", + "description": "Retrieve skill-based Contact Service Queues by skill profile ID in a given organization.", "header": [ { "key": "Accept", @@ -39544,7 +39539,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"F0de6CEeFEffdBa4fEEe1E5D6D8Fb9dd\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"6c55f78CFfB5-1cA0-bc45cb104C8e8F5c\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"F0de6CEeFEffdBa4fEEe1E5D6D8Fb9dd\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"6c55f78CFfB5-1cA0-bc45cb104C8e8F5c\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -39775,7 +39770,7 @@ ] }, { - "name": "Delete References", + "name": "Delete CSQ References", "request": { "body": { "mode": "raw", @@ -39787,7 +39782,7 @@ }, "raw": "{\n \"references\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}" }, - "description": "Delete References for existing Contact Service Queue in a given organization.", + "description": "Delete references for Contact Service Queues in a given organization.", "header": [ { "key": "Content-Type", @@ -39812,6 +39807,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" } @@ -39866,6 +39862,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -39920,6 +39917,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -39974,6 +39972,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -40028,6 +40027,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -40037,7 +40037,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -40082,6 +40082,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -40136,6 +40137,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -40190,6 +40192,7 @@ "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -40200,7 +40203,7 @@ ] }, { - "name": "Fetch manually assignable Queues", + "name": "List Manually Assignable CSQs", "request": { "body": { "mode": "raw", @@ -40212,6 +40215,7 @@ }, "raw": "{\n \"agentId\": \"\",\n \"teamId\": \"\"\n}" }, + "description": "Retrieve manually assignable Contact Service Queues in a given organization.", "header": [ { "key": "Content-Type", @@ -40356,7 +40360,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"34a86D51-Da9DBc7D-aBAD-EC550ff5a530\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"4EF25fa2-93c47fe6-6f8D5B98EbbD81b0\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"34a86D51-Da9DBc7D-aBAD-EC550ff5a530\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"4EF25fa2-93c47fe6-6f8D5B98EbbD81b0\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -40912,7 +40916,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -41009,7 +41013,7 @@ ] }, { - "name": "Get specific Contact Service Queue by Id", + "name": "Get specific Contact Service Queue by ID", "request": { "description": "Retrieve an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -41262,7 +41266,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -41377,7 +41381,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -41438,7 +41442,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41497,7 +41501,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41556,7 +41560,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41615,7 +41619,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41674,7 +41678,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41714,7 +41718,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -41733,7 +41737,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41792,7 +41796,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -41851,7 +41855,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -42236,7 +42240,7 @@ ] }, { - "name": "List references for a specific Contact Service Queue", + "name": "List CSQ References by ID", "request": { "description": "Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -43134,12 +43138,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43159,12 +43163,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43172,9 +43176,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43217,12 +43226,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43242,12 +43251,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43255,9 +43264,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43300,12 +43314,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43325,12 +43339,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43338,9 +43352,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43383,12 +43402,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43408,12 +43427,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43421,9 +43440,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43466,12 +43490,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43491,12 +43515,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43504,9 +43528,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43519,7 +43548,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"EMAIL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\\u000bluFzA\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LINEAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"C4aDCCd980B4-6aFD-9146-B6e2cD1ddaA7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"321959\",\n \"vendorId\": \"E\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"aC42Bc3c-b6cF7F5b-DeDA-B9a8dd20312D\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"dAD29EFE-AB31904a-5e58-E4Ef4AB7D34C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"09RjLc\u2003\u202fUM\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"e53BEb5d-BdCFBEEABF4b-Df2dc5568D4B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"556607\",\n \"vendorId\": \"Ju0&Y1x\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"Cd4F0ebB-Eda8FCaD-e9DAb28032ACAa0B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"35ccc62f453D67D5-BC2d-DcA74F84081F\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"orgid\": \"\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"actualSummariesInclusionCount\": \"\"\n },\n \"data\": [\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"EMAIL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\\u000bluFzA\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LINEAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"C4aDCCd980B4-6aFD-9146-B6e2cD1ddaA7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"321959\",\n \"vendorId\": \"E\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"aC42Bc3c-b6cF7F5b-DeDA-B9a8dd20312D\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"dAD29EFE-AB31904a-5e58-E4Ef4AB7D34C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"09RjLc\u2003\u202fUM\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"e53BEb5d-BdCFBEEABF4b-Df2dc5568D4B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"556607\",\n \"vendorId\": \"Ju0&Y1x\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"Cd4F0ebB-Eda8FCaD-e9DAb28032ACAa0B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"35ccc62f453D67D5-BC2d-DcA74F84081F\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -43549,12 +43578,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43574,12 +43603,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43587,9 +43616,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43632,12 +43666,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -43657,12 +43691,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -43670,9 +43704,14 @@ "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&singleObjectResponse=false&includeAIMappingCount=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -43696,7 +43735,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Create a new Contact Service Queue in a given organization.", "header": [ @@ -43752,7 +43791,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43807,7 +43846,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43862,7 +43901,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43917,7 +43956,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -43972,7 +44011,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44008,7 +44047,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 201, "cookie": [], "header": [ @@ -44027,7 +44066,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44082,7 +44121,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -44121,7 +44160,7 @@ { "name": "List agent based Contact Service Queue(s)by user ID", "request": { - "description": "Retrieve a list of agent based Contact Service Queue(s) by user id in a given organization.", + "description": "Retrieve a list of agent based Contact Service Queue(s) by user iD in a given organization.", "header": [ { "key": "Accept", @@ -44432,7 +44471,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -44563,7 +44602,7 @@ { "name": "List skill based Contact Service Queue(s)by user ID", "request": { - "description": "Retrieve a list of skill based Contact Service Queue(s) by user id in a given organization.", + "description": "Retrieve a list of skill based Contact Service Queue(s) by user ID in a given organization.", "header": [ { "key": "Accept", @@ -44682,7 +44721,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -45003,9 +45042,9 @@ ] }, { - "name": "List Team based Contact Service Queue(s)by user id", + "name": "List team based Contact Service Queue(s)by user ID", "request": { - "description": "Retrieve a list of team based Contact Service Queue(s) by user id in a given organization.", + "description": "Retrieve a list of team based Contact Service Queue(s) by user ID in a given organization.", "header": [ { "key": "Accept", @@ -45316,7 +45355,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"BfE5FF5C-0ce3c4Aa-cF16cf9D7aeb602D\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Af2c2Ac5ecD5-08DF-c0aAc1e7f4BCCC91\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"routingPattern\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -45445,7 +45484,7 @@ ] }, { - "name": "Get specific Contact Service Queue by Id", + "name": "Get specific Contact Service Queue by ID", "request": { "description": "Retrieve an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -45703,7 +45742,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -45820,7 +45859,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "description": "Update an existing Contact Service Queue by ID in a given organization.", "header": [ @@ -45882,7 +45921,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -45942,7 +45981,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -45983,7 +46022,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"Xb\u2029\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"TELEPHONY\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"Xb\u2029\",\n \"queueRoutingType\": \"SKILL_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"SKILLS_BASED\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"9da16fdc-490fDca51eDD-FbeF6BFBAeE2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"0606\",\n \"vendorId\": \"3Qdh\u2003\\u000bMV\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"bb7CE0696AfB-6C8bE0BaeeCd86909AEF\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"E2Bdb08a-307F-DA68-E5c2B0dA09e55Bf7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\",\n \"evaluationModeStartTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -46002,7 +46041,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46062,7 +46101,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46122,7 +46161,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46182,7 +46221,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46242,7 +46281,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46302,7 +46341,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\u202f\u205f\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"name\": \"\u202f\u205f\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"routingType\": \"LONGEST_AVAILABLE_AGENT\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"51d38AEBC77A03c755eA-a1616D2f4cA3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"monitoringPermitted\": \"\",\n \"parkingPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"recordingAllCallsPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"recordingPauseDuration\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"overflowNumber\": \"\",\n \"vendorId\": \"\u202f0dJt\\u000bb\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"cf3b6b4c-e5fa-b4CA-0beD-E0D651CB0d3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"f2DE701A-e2FeeC2c-bD2bD0bfdfF59ec6\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"queueLevelSummariesInclusion\": \"\",\n \"queueLevelSentimentAnalysisInclusion\": \"\",\n \"queueLevelPredictedWaitTimeInclusion\": \"\",\n \"queueLevelAutoCsatInclusion\": \"\",\n \"queueLevelRealTimeTranscriptionsInclusion\": \"\",\n \"personalizedAIRouting\": {\n \"aiRoutingMode\": \"NONE\",\n \"aiRoutingKPIId\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -46407,7 +46446,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -46468,7 +46507,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present.", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -46529,7 +46568,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden.", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -46590,7 +46629,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further.", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -46651,7 +46690,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation.", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -46773,7 +46812,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred.", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -46848,12 +46887,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -46873,12 +46912,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -46931,12 +46970,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -46956,12 +46995,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47014,12 +47053,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -47039,12 +47078,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47097,12 +47136,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -47122,12 +47161,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47180,12 +47219,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -47205,12 +47244,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47263,12 +47302,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -47288,12 +47327,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47316,7 +47355,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"EMAIL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\\u000bluFzA\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LINEAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"C4aDCCd980B4-6aFD-9146-B6e2cD1ddaA7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"321959\",\n \"vendorId\": \"E\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"aC42Bc3c-b6cF7F5b-DeDA-B9a8dd20312D\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"dAD29EFE-AB31904a-5e58-E4Ef4AB7D34C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"09RjLc\u2003\u202fUM\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"e53BEb5d-BdCFBEEABF4b-Df2dc5568D4B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"556607\",\n \"vendorId\": \"Ju0&Y1x\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"Cd4F0ebB-Eda8FCaD-e9DAb28032ACAa0B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"35ccc62f453D67D5-BC2d-DcA74F84081F\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"orgid\": \"\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n }\n },\n \"data\": [\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"EMAIL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"\\u000bluFzA\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"TEAM_BASED\",\n \"queueType\": \"OUTBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"LINEAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"C4aDCCd980B4-6aFD-9146-B6e2cD1ddaA7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"321959\",\n \"vendorId\": \"E\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"aC42Bc3c-b6cF7F5b-DeDA-B9a8dd20312D\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"dAD29EFE-AB31904a-5e58-E4Ef4AB7D34C\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"callDistributionGroups\": [\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n },\n {\n \"agentGroups\": [\n {\n \"teamId\": \"\"\n },\n {\n \"teamId\": \"\"\n }\n ],\n \"order\": \"\",\n \"duration\": 0\n }\n ],\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"checkAgentAvailability\": \"\",\n \"controlFlowScriptUrl\": \"\",\n \"defaultMusicInQueueMediaFileId\": \"\",\n \"ivrRequeueUrl\": \"\",\n \"maxActiveContacts\": \"\",\n \"maxTimeInQueue\": \"\",\n \"monitoringPermitted\": \"\",\n \"name\": \"09RjLc\u2003\u202fUM\",\n \"parkingPermitted\": \"\",\n \"pauseRecordingPermitted\": \"\",\n \"queueRoutingType\": \"AGENT_BASED\",\n \"queueType\": \"INBOUND\",\n \"recordingAllCallsPermitted\": \"\",\n \"recordingPermitted\": \"\",\n \"routingType\": \"CIRCULAR\",\n \"serviceLevelThreshold\": \"\",\n \"organizationId\": \"e53BEb5d-BdCFBEEABF4b-Df2dc5568D4B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"timezone\": \"\",\n \"outdialCampaignEnabled\": \"\",\n \"recordingPauseDuration\": \"\",\n \"overflowNumber\": \"556607\",\n \"vendorId\": \"Ju0&Y1x\",\n \"skillBasedRoutingType\": \"BEST_AVAILABLE_AGENT\",\n \"queueSkillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"Cd4F0ebB-Eda8FCaD-e9DAb28032ACAa0B\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"35ccc62f453D67D5-BC2d-DcA74F84081F\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"agents\": [\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n },\n {\n \"id\": \"\",\n \"ciUserId\": \"\"\n }\n ],\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"assistantSkill\": {\n \"assistantSkillId\": \"\",\n \"assistantSkillUpdatedTime\": \"\"\n },\n \"systemDefault\": \"\",\n \"manuallyAssignable\": \"\",\n \"agentsLastUpdatedByUserName\": \"\",\n \"agentsLastUpdatedByUserEmailPrefix\": \"\",\n \"agentsLastUpdatedTime\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -47346,12 +47385,12 @@ ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (callDistributionGroups,queueSkillRequirements,links)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)", "key": "attributes", "value": "" }, @@ -47371,12 +47410,12 @@ "value": "100" }, { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.", "key": "desktopProfileFilter", "value": "false" }, { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.", "key": "provisioningView", "value": "false" }, @@ -47398,14 +47437,9 @@ "status": "OK" } ] - } - ], - "name": "Contact Service Queue" - }, - { - "item": [ + }, { - "name": "Create a new Desktop Layout", + "name": "List queue mapping summary grouped by Assistant Skill", "request": { "body": { "mode": "raw", @@ -47415,9 +47449,9 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Create a new Desktop Layout in a given organization.", + "description": "Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping.", "header": [ { "key": "Content-Type", @@ -47436,9 +47470,23 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -47452,7 +47500,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -47460,7 +47508,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -47470,7 +47518,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47490,23 +47538,38 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -47514,7 +47577,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -47524,7 +47587,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47544,23 +47607,38 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -47568,7 +47646,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -47578,7 +47656,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47598,31 +47676,46 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -47632,7 +47725,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47641,7 +47734,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -47652,23 +47745,38 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -47676,7 +47784,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -47686,7 +47794,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47706,31 +47814,46 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"assistantSkillId\": \"\",\n \"associatedQueueCount\": \"\",\n \"lastAssistantSkillUpdatedTime\": \"\"\n },\n {\n \"assistantSkillId\": \"\",\n \"associatedQueueCount\": \"\",\n \"lastAssistantSkillUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -47740,7 +47863,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47749,7 +47872,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -47760,23 +47883,38 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -47784,7 +47922,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -47794,7 +47932,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"assistantSkillIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -47814,46 +47952,47 @@ "path": [ "organization", ":orgid", - "desktop-layout" + "v2", + "contact-service-queue", + "fetch-by-grouped-assistant-skill" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" } ] }, { - "name": "Bulk save Desktop Layout(s)", + "name": "List Internal Skill CSQs by Profile", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Desktop Layout(s) in bulk in a given organization.", + "description": "Retrieve skill-based Contact Service Queues by skill profile ID for internal use in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -47861,79 +48000,31 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "desktop-layout", - "bulk" - ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, { "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "body": "{\n \"meta\": {\n \"key_0\": false\n },\n \"data\": [\n {\n \"organizationId\": \"E4C96eAB3948ddcC-C2C6-482Bf9CfBd1B\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"qsrType\": \"\",\n \"dynamicSkillScore\": \"\",\n \"skillProfileSkillsMatch\": \"\",\n \"dynamicSkillsMatch\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1125DEBA-4545-a1F27c86-c9C241D3D3e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"qsrType\": \"\",\n \"dynamicSkillScore\": \"\",\n \"skillProfileSkillsMatch\": \"\",\n \"dynamicSkillsMatch\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -47941,29 +48032,15 @@ "value": "*/*" } ], - "name": "Multi-Status", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -47971,24 +48048,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -47996,29 +48081,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48026,24 +48097,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -48051,29 +48130,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48081,19 +48146,27 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -48108,27 +48181,13 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48136,14 +48195,22 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } @@ -48153,7 +48220,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -48161,29 +48228,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48191,24 +48244,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -48216,29 +48277,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48246,26 +48293,34 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk" + "contact-service-queue", + "by-skill-profile-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" } ] }, { - "name": "Bulk export Desktop Layout(s)", + "name": "List Team CSQs by Team ID", "request": { - "description": "Export all Desktop Layout(s) in a given organization.", + "description": "Retrieve team-based Contact Service Queues by team ID for internal use in a given organization.", "header": [ { "key": "Accept", @@ -48280,49 +48335,44 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"data\": [\n {\n \"organizationId\": \"F52315b2CcFA-12dB-F90E-E5fAecEA63B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1DC2cB8E-eFb9354a-d1aB-7d9eECe6B7DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -48333,31 +48383,27 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -48386,26 +48432,22 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } @@ -48415,7 +48457,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -48423,7 +48465,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -48439,36 +48481,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -48476,7 +48514,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -48492,36 +48530,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -48529,7 +48563,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -48545,49 +48579,45 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"jsonFileName\": \"\",\n \"teamNames\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"jsonFileName\": \"\",\n \"teamNames\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -48598,45 +48628,41 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "contact-service-queue", + "by-team-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Forbidden" } ] }, { - "name": "Purge inactive Desktop Layout(s)", + "name": "List Agent CSQs by CI User ID", "request": { - "description": "Purge inactive Desktop Layout(s) older than the configured interval for a given organization.", + "description": "Retrieve agent-based Contact Service Queues by CI user ID for internal use in a given organization.", "header": [ { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48644,22 +48670,22 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } @@ -48668,7 +48694,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -48676,7 +48702,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -48684,7 +48710,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48692,31 +48718,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -48724,7 +48751,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -48732,7 +48759,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48740,31 +48767,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -48772,7 +48800,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -48780,7 +48808,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48788,47 +48816,48 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"data\": [\n {\n \"organizationId\": \"F52315b2CcFA-12dB-F90E-E5fAecEA63B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1DC2cB8E-eFb9354a-d1aB-7d9eECe6B7DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48836,31 +48865,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -48868,7 +48898,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -48876,7 +48906,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48884,79 +48914,32 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", - "variable": [ + "key": "orgid", + "value": "" + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -48964,7 +48947,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -48972,7 +48955,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -48980,40 +48963,55 @@ "path": [ "organization", ":orgid", - "desktop-layout", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "contact-service-queue", + "by-user-ci-id", + ":ciUserId", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "description": "ciUserId", + "key": "ciUserId", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" } ] }, { - "name": "Get specific Desktop Layout by ID", + "name": "List CSQs by Skills and Profile", "request": { - "description": "Retrieve an existing Desktop Layout by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, + "description": "Retrieve skill-based Contact Service Queues by dynamic skills and skill profile in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49021,20 +49019,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id", - "value": "" } ] } @@ -49053,13 +49046,27 @@ ], "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49067,18 +49074,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } @@ -49088,7 +49092,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -49096,15 +49100,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49112,28 +49130,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -49141,15 +49156,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49157,28 +49186,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -49186,15 +49212,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49202,23 +49242,76 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, + "key": "orgid", + "value": "" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" + ], + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", + "variable": [ { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -49233,13 +49326,27 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49247,18 +49354,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } @@ -49267,7 +49371,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"data\": [\n {\n \"organizationId\": \"F52315b2CcFA-12dB-F90E-E5fAecEA63B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1DC2cB8E-eFb9354a-d1aB-7d9eECe6B7DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -49278,13 +49382,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49292,18 +49410,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-dynamic-skills-and-skillProfile" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } @@ -49313,7 +49428,7 @@ ] }, { - "name": "Update specific Desktop Layout by ID", + "name": "List CSQs by User and Profile", "request": { "body": { "mode": "raw", @@ -49323,9 +49438,9 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, - "description": "Update an existing Desktop Layout by ID in a given organization.", + "description": "Retrieve skill-based Contact Service Queues by user ID and skill profile ID in a given organization.", "header": [ { "key": "Content-Type", @@ -49336,7 +49451,7 @@ "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49344,20 +49459,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id", - "value": "" } ] } @@ -49366,7 +49476,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -49374,7 +49484,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -49384,7 +49494,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49396,66 +49506,7 @@ "value": "application/json" } ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "desktop-layout", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49463,23 +49514,20 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -49502,7 +49550,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49514,7 +49562,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49522,18 +49570,15 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } @@ -49541,17 +49586,17 @@ "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"data\": [\n {\n \"organizationId\": \"F52315b2CcFA-12dB-F90E-E5fAecEA63B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1DC2cB8E-eFb9354a-d1aB-7d9eECe6B7DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -49561,7 +49606,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49570,10 +49615,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49581,28 +49626,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Precondition Failed" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -49610,7 +49652,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -49620,7 +49662,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49632,7 +49674,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49640,28 +49682,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 500, "cookie": [], "header": [ { @@ -49669,7 +49708,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -49679,7 +49718,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49691,7 +49730,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49699,28 +49738,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -49728,7 +49764,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -49738,7 +49774,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49750,7 +49786,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49758,28 +49794,25 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -49787,7 +49820,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -49797,7 +49830,7 @@ "language": "json" } }, - "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"skillProfileId\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillId\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}" }, "header": [ { @@ -49809,7 +49842,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -49817,37 +49850,34 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "fetch-by-userId-skillProfileId" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "key": "orgid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" } ] }, { - "name": "Delete specific Desktop Layout by ID", + "name": "List Skill CSQs by CI User ID", "request": { - "description": "Delete an existing Desktop Layout by ID in a given organization.", + "description": "Retrieve skill-based Contact Service Queues by CI user ID for internal use in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -49855,10 +49885,13 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -49866,7 +49899,7 @@ "value": "" }, { - "description": "Resource ID of the Desktop Layout.", + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -49877,7 +49910,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -49885,7 +49918,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -49893,7 +49926,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -49901,28 +49934,33 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 401, "cookie": [], "header": [ { @@ -49930,7 +49968,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -49938,7 +49976,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -49946,28 +49984,33 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -49975,7 +50018,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -49983,7 +50026,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -49991,44 +50034,49 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": false\n },\n \"data\": [\n {\n \"organizationId\": \"E4C96eAB3948ddcC-C2C6-482Bf9CfBd1B\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"qsrType\": \"\",\n \"dynamicSkillScore\": \"\",\n \"skillProfileSkillsMatch\": \"\",\n \"dynamicSkillsMatch\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"1125DEBA-4545-a1F27c86-c9C241D3D3e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"channelType\": \"\",\n \"name\": \"\",\n \"skillScore\": \"\",\n \"qsrType\": \"\",\n \"dynamicSkillScore\": \"\",\n \"skillProfileSkillsMatch\": \"\",\n \"dynamicSkillsMatch\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -50036,28 +50084,33 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -50065,7 +50118,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -50073,42 +50126,7 @@ "value": "application/json" } ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "desktop-layout", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Layout.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, - "cookie": [], - "header": [], - "name": "OK", - "originalRequest": { - "header": [], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -50116,28 +50134,33 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -50145,7 +50168,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -50153,7 +50176,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -50161,37 +50184,61 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id" + "contact-service-queue", + "skill-based-queues", + "by-ci-user-id", + ":id", + "internal" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "raw": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" }, { - "description": "Resource ID of the Desktop Layout.", - "key": "id" + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Not Found" } ] - }, + } + ], + "name": "Contact Service Queue" + }, + { + "item": [ { - "name": "List references for a specific Desktop Layout", + "name": "Create a new Desktop Layout", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Desktop Layout by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Create a new Desktop Layout in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50199,38 +50246,14 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" } ] } @@ -50239,7 +50262,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -50247,15 +50270,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50263,46 +50300,23 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 400, "cookie": [], "header": [ { @@ -50310,15 +50324,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50326,46 +50354,23 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -50373,15 +50378,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50389,45 +50408,22 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -50438,13 +50434,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50452,36 +50462,13 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } @@ -50491,7 +50478,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -50499,15 +50486,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50515,46 +50516,23 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -50562,15 +50540,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50578,55 +50570,100 @@ "path": [ "organization", ":orgid", - "desktop-layout", - ":id", - "incoming-references" + "desktop-layout" ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", + "variable": [ { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Similar entity is already present", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "desktop-layout" + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Conflict" } ] }, { - "name": "List Desktop Layout(s)", + "name": "Bulk save Desktop Layout(s)", "request": { - "description": "Retrieve a list of Desktop Layout(s) in a given organization. Json file content field won't be avalible in get all even though it is showing in sample response structure. and it will be avialable only in get by id.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Desktop Layout(s) in bulk in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50634,42 +50671,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -50683,7 +50688,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -50691,15 +50696,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50707,42 +50726,65 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" + "desktop-layout", + "bulk" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Multi-Status", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "path": [ + "organization", + ":orgid", + "desktop-layout", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -50751,12 +50793,12 @@ ] } }, - "status": "Forbidden" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 400, "cookie": [], "header": [ { @@ -50764,15 +50806,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50780,42 +50836,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -50824,12 +50848,12 @@ ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -50837,15 +50861,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50853,42 +50891,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -50897,7 +50903,7 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -50912,13 +50918,27 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50926,42 +50946,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -50973,25 +50961,39 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"8fcAAe3d3b635d94eaBA-df480F600ED7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"AAAcaf77a4ae-84EcDEa5dE416f5d13b8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -50999,42 +51001,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51043,12 +51013,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -51056,15 +51026,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"4f872fA0Dd371BC5-8CCf45eC336Cdc04\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"315d301426b0ccAd-b7D8-CDCEFFBDaeed\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -51072,42 +51056,10 @@ "path": [ "organization", ":orgid", - "v2", - "desktop-layout" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } + "desktop-layout", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51116,19 +51068,14 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" } ] - } - ], - "name": "Desktop Layout" - }, - { - "item": [ + }, { - "name": "List Desktop Profile(s)", + "name": "Bulk export Desktop Layout(s)", "request": { - "description": "Retrieve a list of Desktop Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Export all Desktop Layout(s) in a given organization.", "header": [ { "key": "Accept", @@ -51143,19 +51090,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51164,15 +51102,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51186,7 +51119,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -51194,7 +51127,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -51210,19 +51143,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51231,15 +51155,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51248,12 +51167,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -51261,7 +51180,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -51277,19 +51196,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51298,15 +51208,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51315,12 +51220,12 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -51328,7 +51233,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -51344,19 +51249,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51365,15 +51261,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51382,25 +51273,25 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"V2\u202fS\u2007bk\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"c8bcdccE28Cb-ab4Af40f5515AC367abE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"EXTENSION\",\n \"AGENT_DN\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"ALL\",\n \"organizationId\": \"be2CcB10-Bb92-5AD8fEa3e54cccBD200a\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"accessBuddyTeam\": \"NONE\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"6Scm\u1680nFb\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"30Cd954e-962Eb9eA-D1d9-bb8cdab70B7d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"EXTENSION\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"ALL\",\n \"organizationId\": \"95096203-9A57-fb5cec7c-EB5607F2Af1a\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -51411,19 +51302,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51432,15 +51314,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51449,7 +51326,7 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -51478,19 +51355,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51499,15 +51367,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51519,22 +51382,22 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"jsonFileName\": \"\",\n \"teamNames\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"jsonFileName\": \"\",\n \"teamNames\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -51545,19 +51408,10 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "bulk-export" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -51566,15 +51420,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51583,29 +51432,15 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" } ] }, { - "name": "Create a new Desktop Profile", + "name": "Purge inactive Desktop Layout(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Create a new Desktop Profile in a given organization.", + "description": "Purge inactive Desktop Layout(s) older than the configured interval for a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" @@ -51619,9 +51454,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51635,7 +51478,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -51643,23 +51486,9 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -51673,9 +51502,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51684,7 +51521,7 @@ ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -51699,21 +51536,7 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -51727,9 +51550,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51743,7 +51574,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -51751,23 +51582,9 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -51781,9 +51598,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51792,39 +51617,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -51835,9 +51646,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51846,7 +51665,7 @@ ] } }, - "status": "Created" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -51861,21 +51680,7 @@ ], "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -51889,9 +51694,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51903,36 +51716,22 @@ "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -51943,9 +51742,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -51954,7 +51761,7 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -51969,21 +51776,7 @@ ], "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -51997,9 +51790,17 @@ "path": [ "organization", ":orgid", - "agent-profile" + "desktop-layout", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -52013,30 +51814,16 @@ ] }, { - "name": "Bulk save Desktop Profile(s)", + "name": "Get specific Desktop Layout by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Desktop Profile(s) in bulk in a given organization.", + "description": "Retrieve an existing Desktop Layout by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52044,15 +51831,20 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id", + "value": "" } ] } @@ -52061,7 +51853,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -52069,29 +51861,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52099,24 +51877,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -52124,29 +51906,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52154,24 +51922,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -52179,29 +51951,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52209,19 +51967,23 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -52236,27 +51998,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52264,14 +52012,18 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } @@ -52281,7 +52033,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -52289,29 +52041,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52319,109 +52057,44 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Similar entity is already present", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - "bulk" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "Multi-Status", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -52429,33 +52102,51 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk" + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "OK" } ] }, { - "name": "Bulk export Desktop Profile(s)", + "name": "Update specific Desktop Layout by ID", "request": { - "description": "Export all Desktop Profile(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Update an existing Desktop Layout by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52463,27 +52154,20 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id", + "value": "" } ] } @@ -52492,7 +52176,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -52500,15 +52184,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52516,35 +52214,27 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"accessBuddyTeam\": \"\",\n \"accessEntryPoint\": \"\",\n \"accessIdleCode\": \"\",\n \"accessQueue\": \"\",\n \"accessQueueStats\": \"\",\n \"accessTeamStats\": \"\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"agentDNValidation\": \"\",\n \"name\": \"6-2I\u1680\u2002H\",\n \"parentType\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeamsList\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPoint\": \"\",\n \"addressBook\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"outdialANI\": \"\",\n \"agentDNValidationCriteria\": \"\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"agentStats\": \"\",\n \"viewableStatsQueue\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"viewableStatsTeam\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\"\n },\n {\n \"accessBuddyTeam\": \"\",\n \"accessEntryPoint\": \"\",\n \"accessIdleCode\": \"\",\n \"accessQueue\": \"\",\n \"accessQueueStats\": \"\",\n \"accessTeamStats\": \"\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"agentDNValidation\": \"\",\n \"name\": \"\u2007f(h\u2009\u2002c5P\",\n \"parentType\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeamsList\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPoint\": \"\",\n \"addressBook\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"outdialANI\": \"\",\n \"agentDNValidationCriteria\": \"\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"agentStats\": \"\",\n \"viewableStatsQueue\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"viewableStatsTeam\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"BROWSER\",\n \"BROWSER\"\n ],\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\"\n }\n ]\n}", + "body": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"758C983d-Cc3c-DdAb-490Ef7dA7ce3f73B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -52555,13 +52245,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52569,26 +52273,18 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } @@ -52608,13 +52304,27 @@ ], "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52622,26 +52332,18 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } @@ -52651,7 +52353,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -52659,15 +52361,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52675,36 +52391,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -52712,15 +52420,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52728,36 +52450,87 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" + "desktop-layout", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Resource ID of the Desktop Layout.", + "key": "id" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "desktop-layout", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -52765,15 +52538,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -52781,45 +52568,96 @@ "path": [ "organization", ":orgid", - "agent-profile", - "bulk-export" + "desktop-layout", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Resource ID of the Desktop Layout.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"a54f4FcEA6e9-6FAA-886AE5bDDD32DddF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "desktop-layout", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" } ] }, { - "name": "Purge inactive Desktop Profile(s)", + "name": "Delete specific Desktop Layout by ID", "request": { - "description": "Purge inactive Desktop Profile(s) older than the configured interval for a given organization.", + "description": "Delete an existing Desktop Layout by ID in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -52827,22 +52665,20 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id", + "value": "" } ] } @@ -52867,7 +52703,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -52875,21 +52711,18 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } @@ -52899,7 +52732,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -52907,7 +52740,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -52915,7 +52748,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -52923,31 +52756,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -52955,7 +52785,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -52963,7 +52793,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -52971,31 +52801,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -53003,7 +52830,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -53011,7 +52838,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -53019,31 +52846,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -53051,7 +52875,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -53059,7 +52883,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -53067,47 +52891,34 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 200, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Similar entity is already present", + "header": [], + "name": "OK", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -53115,47 +52926,44 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -53163,33 +52971,30 @@ "path": [ "organization", ":orgid", - "agent-profile", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "desktop-layout", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Layout.", + "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "Get specific Desktop Profile by ID", + "name": "List references for a specific Desktop Layout", "request": { - "description": "Retrieve an existing Desktop Profile by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Desktop Layout by ID in a given organization.", "header": [ { "key": "Accept", @@ -53204,10 +53009,28 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -53215,7 +53038,7 @@ "value": "" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -53226,7 +53049,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -53234,7 +53057,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -53250,23 +53073,41 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -53295,17 +53136,35 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] @@ -53340,17 +53199,35 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] @@ -53359,22 +53236,22 @@ "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -53385,41 +53262,59 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -53430,28 +53325,46 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -53459,7 +53372,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -53475,51 +53388,55 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "desktop-layout", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Desktop Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Update specific Desktop Profile by ID", + "name": "List Desktop Layout(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Update an existing Desktop Profile by ID in a given organization.", + "description": "Retrieve a list of Desktop Layout(s) in a given organization. Json file content field won't be avalible in get all even though it is showing in sample response structure. and it will be avialable only in get by id.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -53527,19 +53444,51 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -53549,7 +53498,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -53557,29 +53506,15 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -53587,195 +53522,51 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } @@ -53785,7 +53576,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -53793,29 +53584,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -53823,136 +53600,51 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } @@ -53972,27 +53664,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -54000,157 +53678,61 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - } - ] - }, - { - "name": "Delete specific Desktop Profile by ID", - "request": { - "description": "Delete an existing Desktop Profile by ID in a given organization.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -54158,7 +53740,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -54166,7 +53748,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -54174,89 +53756,77 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 6761\n },\n \"data\": [\n {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"8fcAAe3d3b635d94eaBA-df480F600ED7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"defaultJsonModified\": \"\",\n \"editedBy\": \"\",\n \"global\": \"\",\n \"jsonFileContent\": \"\",\n \"jsonFileName\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"validated\": \"\",\n \"organizationId\": \"AAAcaf77a4ae-84EcDEa5dE416f5d13b8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"validatedTime\": \"\",\n \"defaultJsonModifiedTime\": \"\",\n \"modifiedTime\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -54264,58 +53834,56 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Desktop Profile.", - "key": "id" + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, - "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "agent-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } }, - "status": "No Content" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -54336,7 +53904,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -54344,18 +53912,51 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id" + "v2", + "desktop-layout" ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/desktop-layout?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false&provisioningView=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Desktop Profile.", - "key": "id" } ] } @@ -54363,11 +53964,16 @@ "status": "Internal Server Error" } ] - }, + } + ], + "name": "Desktop Layout" + }, + { + "item": [ { - "name": "List references for a specific Desktop Profile", + "name": "List Desktop Profile(s)", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.", + "description": "Retrieve a list of Desktop Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", @@ -54382,14 +53988,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54401,41 +54010,41 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -54446,14 +54055,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54465,27 +54077,28 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -54493,7 +54106,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -54509,14 +54122,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54528,27 +54144,28 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -54556,7 +54173,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -54572,14 +54189,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54591,40 +54211,41 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"accessBuddyTeam\": \"NONE\",\n \"accessEntryPoint\": \"ALL\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"(e\u2009Gf3.fkW\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"Edf4868B7D7aEaa1-E731-AcC88D1947df\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"NONE\",\n \"organizationId\": \"e82F0Ca3-e5B7EcA29f055A8F1f9a92a4\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"h\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"D7EFE6989BdeFF0f-7b9b-BFD1c174AEce\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"EXTENSION\",\n \"BROWSER\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"ALL\",\n \"organizationId\": \"11feb8ec4a9FAac37BbA-bA2aC7daeCdA\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -54635,14 +54256,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54654,27 +54278,28 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -54682,7 +54307,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -54698,14 +54323,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54717,27 +54345,28 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -54745,7 +54374,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -54761,14 +54390,17 @@ "path": [ "organization", ":orgid", - "agent-profile", - ":id", - "incoming-references" + "agent-profile" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", "value": "" }, { @@ -54780,36 +54412,51 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "List Desktop Profile(s)", + "name": "Create a new Desktop Profile", "request": { - "description": "Retrieve a list of Desktop Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Create a new Desktop Profile in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -54817,42 +54464,9 @@ "path": [ "organization", ":orgid", - "v2", "agent-profile" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -54866,7 +54480,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 409, "cookie": [], "header": [ { @@ -54874,161 +54488,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "v2", - "agent-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "v2", - "agent-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"orgid\": \"f1d8cdcf-B86d-b3DA7aa8-cD77D5Fd9dDF\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"accessBuddyTeam\": \"NONE\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"PROVISIONED_VALUE\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"active\": \"\",\n \"agentDNValidation\": \"SPECIFIC\",\n \"name\": \"\ufeffx\\f\u1680\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"B9c1efc4-D4C9-faDfc44e-4d86D449Adc1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"BROWSER\",\n \"AGENT_DN\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"ALL\",\n \"organizationId\": \"d4474a94-7BE4E14C052Fd32DAc3Ddcc6\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"accessBuddyTeam\": \"PROVISIONED_VALUE\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"-5q\\t9\u3000\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"d094baA26de5-C9A1-D2e09C7A961ea38A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"SPECIFIC\",\n \"accessTeamStats\": \"NONE\",\n \"organizationId\": \"aE1d0c6a-A678-D823b282-A2aA87Af2eDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55036,42 +54518,9 @@ "path": [ "organization", ":orgid", - "v2", "agent-profile" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55080,12 +54529,12 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -55093,15 +54542,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55109,42 +54572,9 @@ "path": [ "organization", ":orgid", - "v2", "agent-profile" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55153,7 +54583,7 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -55168,13 +54598,27 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55182,42 +54626,9 @@ "path": [ "organization", ":orgid", - "v2", "agent-profile" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55229,220 +54640,39 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Created", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "v2", - "agent-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Too Many Requests" - } - ] - } - ], - "name": "Desktop Profile" - }, - { - "item": [ - { - "name": "List Dialed Number Mapping(s)", - "request": { - "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ + }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55450,31 +54680,9 @@ "path": [ "organization", ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55483,12 +54691,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -55496,15 +54704,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55512,31 +54734,9 @@ "path": [ "organization", ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55545,7 +54745,7 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -55560,75 +54760,27 @@ ], "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"DfE30d4dEFf9-31b8fcCb-0F3eaA1fb32C\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+65911\",\n \"extension\": \"518\",\n \"routingPrefix\": \"7906697\",\n \"esn\": \"86\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n },\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"Fb964fB41d02C00F-EA0BdAFAf590Acce\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"628767838189\",\n \"extension\": \"62870\",\n \"routingPrefix\": \"91\",\n \"esn\": \"793070\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n }\n]", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55636,31 +54788,9 @@ "path": [ "organization", ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55669,12 +54799,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -55682,15 +54812,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -55698,31 +54842,9 @@ "path": [ "organization", ":orgid", - "dial-number" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55731,12 +54853,12 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" } ] }, { - "name": "Create a new Dialed Number Mapping", + "name": "Bulk save Desktop Profile(s)", "request": { "body": { "mode": "raw", @@ -55746,9 +54868,9 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create a new Dialed Number Mapping in a given organization.", + "description": "Create, Update or delete Desktop Profile(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -55767,9 +54889,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55783,7 +54906,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -55791,7 +54914,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -55801,7 +54924,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -55821,9 +54944,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55832,12 +54956,12 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -55845,7 +54969,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -55855,7 +54979,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -55875,9 +54999,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55886,12 +55011,12 @@ ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -55899,7 +55024,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -55909,7 +55034,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -55929,9 +55054,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55940,12 +55066,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -55953,7 +55079,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -55963,7 +55089,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -55983,9 +55109,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -55994,20 +55121,20 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -56017,7 +55144,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -56026,7 +55153,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -56037,9 +55164,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56048,12 +55176,12 @@ ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 409, "cookie": [], "header": [ { @@ -56061,7 +55189,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -56071,7 +55199,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -56091,9 +55219,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56102,20 +55231,20 @@ ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -56125,7 +55254,7 @@ "language": "json" } }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"ALL\",\n \"name\": \"F\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"dd34A813-Ae89-FDfc0D6eEF711f90DD95\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"DcC975B2a731-0f2a-0DcA-835E9777EDBc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"AGENT_DN\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessBuddyTeam\": \"SPECIFIC\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"SPECIFIC\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"_Uv\u20062CQl\",\n \"parentType\": \"ORGANIZATION\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"PROVISIONED_VALUE\",\n \"accessTeamStats\": \"SPECIFIC\",\n \"organizationId\": \"DfAd6efd4e75-4dcfbfbC-c5eEEbD801f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"BB1Ece34-d0dcCbd8AFbf-d2EaEb36b0E3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"NONE\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -56134,7 +55263,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -56145,9 +55274,10 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56156,21 +55286,21 @@ ] } }, - "status": "Forbidden" + "status": "Multi-Status (WebDAV) (RFC 4918)" } ] }, { - "name": "Delete all Dialed Number Mapping(s)", + "name": "Bulk export Desktop Profile(s)", "request": { - "description": "Delete all Dialed Number Mapping(s) in a given organization.", + "description": "Export all Desktop Profile(s) in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56178,9 +55308,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56194,7 +55337,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -56202,7 +55345,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -56210,7 +55353,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56218,9 +55361,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56229,18 +55385,28 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", - "body": null, + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"accessBuddyTeam\": \"\",\n \"accessEntryPoint\": \"\",\n \"accessIdleCode\": \"\",\n \"accessQueue\": \"\",\n \"accessQueueStats\": \"\",\n \"accessTeamStats\": \"\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"agentDNValidation\": \"\",\n \"name\": \"6-2I\u1680\u2002H\",\n \"parentType\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeamsList\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPoint\": \"\",\n \"addressBook\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"outdialANI\": \"\",\n \"agentDNValidationCriteria\": \"\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"agentStats\": \"\",\n \"viewableStatsQueue\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"viewableStatsTeam\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\"\n },\n {\n \"accessBuddyTeam\": \"\",\n \"accessEntryPoint\": \"\",\n \"accessIdleCode\": \"\",\n \"accessQueue\": \"\",\n \"accessQueueStats\": \"\",\n \"accessTeamStats\": \"\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"agentDNValidation\": \"\",\n \"name\": \"\u2007f(h\u2009\u2002c5P\",\n \"parentType\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeamsList\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPoint\": \"\",\n \"addressBook\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"outdialANI\": \"\",\n \"agentDNValidationCriteria\": \"\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"agentStats\": \"\",\n \"viewableStatsQueue\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"viewableStatsTeam\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"BROWSER\",\n \"BROWSER\"\n ],\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], - "header": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56248,9 +55414,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56264,7 +55443,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -56272,7 +55451,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -56280,7 +55459,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56288,9 +55467,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56299,12 +55491,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -56312,7 +55504,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -56320,7 +55512,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56328,9 +55520,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56339,12 +55544,12 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -56352,7 +55557,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -56360,7 +55565,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56368,9 +55573,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56379,12 +55597,12 @@ ] } }, - "status": "Precondition Failed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -56392,7 +55610,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -56400,7 +55618,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -56408,49 +55626,22 @@ "path": [ "organization", ":orgid", - "dial-number" + "agent-profile", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56459,29 +55650,15 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "Bulk save Dialed Number Mapping(s)", + "name": "Purge inactive Desktop Profile(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization.", + "description": "Purge inactive Desktop Profile(s) older than the configured interval for a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" @@ -56495,10 +55672,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56522,21 +55706,7 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -56550,10 +55720,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56577,21 +55754,7 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -56605,10 +55768,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56620,36 +55790,22 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -56660,10 +55816,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56672,7 +55835,7 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -56687,21 +55850,7 @@ ], "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -56715,10 +55864,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56732,7 +55888,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -56740,23 +55896,9 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -56770,10 +55912,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56782,12 +55931,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -56795,23 +55944,9 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -56825,10 +55960,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56837,39 +55979,25 @@ ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Similar entity is already present", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -56880,10 +56008,17 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk" + "agent-profile", + "purge-inactive-entities" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -56892,14 +56027,14 @@ ] } }, - "status": "Conflict" + "status": "OK" } ] }, { - "name": "Bulk export Dialed Number Mapping(s)", + "name": "Get specific Desktop Profile by ID", "request": { - "description": "Export all Dialed Number Mapping(s) in a given organization.", + "description": "Retrieve an existing Desktop Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -56914,27 +56049,20 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id", + "value": "" } ] } @@ -56943,7 +56071,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -56951,7 +56079,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -56967,36 +56095,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -57004,7 +56124,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -57020,36 +56140,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -57057,7 +56169,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -57073,49 +56185,41 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"dialledNumber\": \"\",\n \"entryPointName\": \"\",\n \"region\": \"\"\n },\n {\n \"dialledNumber\": \"\",\n \"entryPointName\": \"\",\n \"region\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -57126,49 +56230,41 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -57179,36 +56275,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -57216,7 +56304,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -57232,45 +56320,51 @@ "path": [ "organization", ":orgid", - "dial-number", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" } ] }, { - "name": "List only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)", + "name": "Update specific Desktop Profile by ID", "request": { - "description": "Retrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Update an existing Desktop Profile by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57278,23 +56372,146 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id", + "value": "" } ] } }, "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "agent-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" + } + ] + } + }, + "status": "Precondition Failed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "agent-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, { "_postman_previewlanguage": "text", - "body": "[\n \"\",\n \"\"\n]", + "body": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"SPECIFIC\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"NONE\",\n \"name\": \"j\u205f4\",\n \"parentType\": \"SITE\",\n \"organizationId\": \"49CD27Fc-0eAD-e209-527eA053AFD283dE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"ALL\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"b5B1e36836422257-C5ee10dEF6A3ba1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -57305,13 +56522,27 @@ ], "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57319,14 +56550,18 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } @@ -57336,7 +56571,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -57344,15 +56579,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57360,24 +56609,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -57385,15 +56638,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57401,24 +56668,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -57426,15 +56697,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57442,24 +56727,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -57467,15 +56756,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57483,24 +56786,28 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -57508,15 +56815,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"accessBuddyTeam\": \"ALL\",\n \"accessEntryPoint\": \"NONE\",\n \"accessIdleCode\": \"ALL\",\n \"accessQueue\": \"NONE\",\n \"accessWrapUpCode\": \"ALL\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"3\",\n \"parentType\": \"SITE\",\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"e86f4beF-aD09-4C04293A-eBAaDF692a51\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"organizationId\": \"Ac48FeEd06Fb-fAb1dc87DC0B4655EEe0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"agentDNValidationCriteria\": \"SPECIFIC\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"BROWSER\"\n ],\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -57524,33 +56845,37 @@ "path": [ "organization", ":orgid", - "dial-number", - "numbers-only" + "agent-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" } ] }, { - "name": "Get specific Dialed Number Mapping by ID", + "name": "Delete specific Desktop Profile by ID", "request": { - "description": "Retrieve an existing Dialed Number Mapping by ID in a given organization.", + "description": "Delete an existing Desktop Profile by ID in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57558,10 +56883,10 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -57569,7 +56894,7 @@ "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id", "value": "" } @@ -57580,7 +56905,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -57588,7 +56913,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -57596,7 +56921,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57604,28 +56929,28 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 412, "cookie": [], "header": [ { @@ -57633,7 +56958,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -57641,7 +56966,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57649,44 +56974,44 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57694,28 +57019,28 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -57723,7 +57048,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -57731,7 +57056,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57739,28 +57064,28 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -57768,7 +57093,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -57776,7 +57101,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57784,28 +57109,63 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "agent-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Desktop Profile.", + "key": "id" + } + ] + } + }, + "status": "No Content" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -57813,7 +57173,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -57821,7 +57181,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -57829,51 +57189,37 @@ "path": [ "organization", ":orgid", - "dial-number", + "agent-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Resource ID of the Desktop Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" } ] }, { - "name": "Update specific Dialed Number Mapping by ID", + "name": "List references for a specific Desktop Profile", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, - "description": "Update an existing Dialed Number Mapping by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -57881,18 +57227,36 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -57901,39 +57265,25 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -57941,28 +57291,46 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -57970,29 +57338,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58000,23 +57354,41 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -58031,27 +57403,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58059,82 +57417,41 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" ], - "path": [ - "organization", - ":orgid", - "dial-number", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -58149,27 +57466,13 @@ ], "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58177,17 +57480,35 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] @@ -58198,7 +57519,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -58206,29 +57527,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58236,28 +57543,46 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -58265,29 +57590,15 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58295,96 +57606,55 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "agent-profile", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - }, - "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dialed Number Mapping.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "Delete specific Dialed Number Mapping by ID", + "name": "List Desktop Profile(s)", "request": { - "description": "Delete an existing Dialed Number Mapping by ID in a given organization.", + "description": "Retrieve a list of Desktop Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58392,19 +57662,46 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -58414,7 +57711,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 404, "cookie": [], "header": [ { @@ -58422,7 +57719,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -58430,7 +57727,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58438,58 +57735,51 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, - "cookie": [], - "header": [], - "name": "OK", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-number", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -58510,7 +57800,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58518,18 +57808,46 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } @@ -58537,25 +57855,25 @@ "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"orgid\": \"f1d8cdcf-B86d-b3DA7aa8-cD77D5Fd9dDF\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"accessBuddyTeam\": \"NONE\",\n \"accessEntryPoint\": \"SPECIFIC\",\n \"accessIdleCode\": \"PROVISIONED_VALUE\",\n \"accessQueue\": \"PROVISIONED_VALUE\",\n \"accessWrapUpCode\": \"SPECIFIC\",\n \"active\": \"\",\n \"agentDNValidation\": \"SPECIFIC\",\n \"name\": \"\ufeffx\\f\u1680\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"B9c1efc4-D4C9-faDfc44e-4d86D449Adc1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"BROWSER\",\n \"AGENT_DN\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"NONE\",\n \"accessTeamStats\": \"ALL\",\n \"organizationId\": \"d4474a94-7BE4E14C052Fd32DAc3Ddcc6\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"accessBuddyTeam\": \"PROVISIONED_VALUE\",\n \"accessEntryPoint\": \"PROVISIONED_VALUE\",\n \"accessIdleCode\": \"NONE\",\n \"accessQueue\": \"ALL\",\n \"accessWrapUpCode\": \"NONE\",\n \"active\": \"\",\n \"agentDNValidation\": \"PROVISIONED_VALUE\",\n \"name\": \"-5q\\t9\u3000\",\n \"parentType\": \"ORGANIZATION\",\n \"organizationId\": \"d094baA26de5-C9A1-D2e09C7A961ea38A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"siteId\": \"\",\n \"screenPopup\": \"\",\n \"lastAgentRouting\": \"\",\n \"autoWrapUp\": \"\",\n \"autoAnswer\": \"\",\n \"autoWrapAfterSeconds\": \"\",\n \"agentAvailableAfterOutdial\": \"\",\n \"allowAutoWrapUpExtension\": \"\",\n \"wrapUpCodes\": [\n \"\",\n \"\"\n ],\n \"idleCodes\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"buddyTeams\": [\n \"\",\n \"\"\n ],\n \"consultToQueue\": \"\",\n \"outdialEnabled\": \"\",\n \"outdialEntryPointId\": \"\",\n \"outdialANIId\": \"\",\n \"addressBookId\": \"\",\n \"dialPlanEnabled\": \"\",\n \"dialPlans\": [\n \"\",\n \"\"\n ],\n \"timeoutDesktopInactivityCustomEnabled\": \"\",\n \"showUserDetailsMS\": \"\",\n \"stateSynchronizationMS\": \"\",\n \"showUserDetailsWebex\": \"\",\n \"stateSynchronizationWebex\": \"\",\n \"timeoutDesktopInactivityMins\": \"\",\n \"agentDNValidationCriteria\": \"ALL\",\n \"agentDNValidationCriterions\": [\n \"\",\n \"\"\n ],\n \"loginVoiceOptions\": [\n \"AGENT_DN\",\n \"EXTENSION\"\n ],\n \"viewableStatistics\": {\n \"accessQueueStats\": \"SPECIFIC\",\n \"accessTeamStats\": \"NONE\",\n \"organizationId\": \"aE1d0c6a-A678-D823b282-A2aA87Af2eDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"agentStats\": \"\",\n \"contactServiceQueues\": [\n \"\",\n \"\"\n ],\n \"loggedInTeamStats\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"thresholdRules\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58563,28 +57881,56 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -58592,7 +57938,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -58600,7 +57946,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58608,28 +57954,56 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -58637,7 +58011,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -58645,7 +58019,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58653,28 +58027,56 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -58682,7 +58084,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -58690,7 +58092,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -58698,30 +58100,63 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id" + "v2", + "agent-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/agent-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Dialed Number Mapping.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" } ] - }, + } + ], + "name": "Desktop Profile" + }, + { + "item": [ { - "name": "List references for a specific Dialed Number Mapping", + "name": "List Dialed Number Mapping(s)", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization.", + "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", "header": [ { "key": "Accept", @@ -58736,14 +58171,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -58757,17 +58195,12 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" } ] } @@ -58776,7 +58209,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -58784,7 +58217,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -58800,14 +58233,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -58821,25 +58257,21 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -58847,7 +58279,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -58863,14 +58295,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -58884,25 +58319,21 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -58910,7 +58341,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -58926,14 +58357,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -58947,25 +58381,21 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -58973,7 +58403,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -58989,14 +58419,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -59010,24 +58443,20 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "body": "[\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"C60ddA23-B4767593-B1ff-79713630c7e6\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"20056611638\",\n \"extension\": \"994403973\",\n \"routingPrefix\": \"2354011\",\n \"esn\": \"1696936453\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n },\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"fBe9eaC090a5F7A31D8aDcaEDFa95c80\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"075804190-\",\n \"extension\": \"693672012\",\n \"routingPrefix\": \"59633\",\n \"esn\": \"78424552266996\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n }\n]", "code": 200, "cookie": [], "header": [ @@ -59052,14 +58481,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -59073,15 +58505,11 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } @@ -59091,7 +58519,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -59099,7 +58527,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -59115,14 +58543,17 @@ "path": [ "organization", ":orgid", - "dial-number", - ":id", - "incoming-references" + "dial-number" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { @@ -59136,34 +58567,44 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" } ] }, { - "name": "List Dialed Number Mapping(s)", + "name": "Create a new Dialed Number Mapping", "request": { - "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, + "description": "Create a new Dialed Number Mapping in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59171,42 +58612,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59220,7 +58628,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -59228,15 +58636,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59244,42 +58666,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59288,12 +58677,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -59301,15 +58690,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59317,42 +58720,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59361,28 +58731,42 @@ ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"dialledNumber\": \"662.2\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"d899aD7D-2988-0972-67B7-e329ceE3c752\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"dialledNumber\": \"811177\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"f7eFef1C25dC87D919eAcE5a41b09F4f\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59390,42 +58774,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59434,12 +58785,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -59447,15 +58798,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59463,42 +58828,63 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "variable": [ { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "path": [ + "organization", + ":orgid", + "dial-number" + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59507,12 +58893,12 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -59520,15 +58906,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59536,42 +58936,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59580,7 +58947,7 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -59595,13 +58962,27 @@ ], "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -59609,42 +58990,9 @@ "path": [ "organization", ":orgid", - "v2", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59658,16 +59006,16 @@ ] }, { - "name": "List Dialed Number Mapping(s)", + "name": "Delete all Dialed Number Mapping(s)", "request": { - "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", + "description": "Delete all Dialed Number Mapping(s) in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -59675,42 +59023,9 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -59740,7 +59055,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -59748,57 +59063,53 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/organization/:orgid/dial-number", + "variable": [ { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "OK", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "path": [ + "organization", + ":orgid", + "dial-number" + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -59806,7 +59117,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -59814,7 +59125,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -59822,73 +59133,39 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": false\n },\n \"data\": [\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"ace8f28BD9Ca-4F9aceA5-B3aEC76C1b9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+5173398\",\n \"extension\": \"229536140\",\n \"routingPrefix\": \"14979\",\n \"esn\": \"60127986\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n },\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"8eF6c0c1-ef9FBDd6CB6A-deCdC24B6cBD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+11662747908406507\",\n \"extension\": \"55268\",\n \"routingPrefix\": \"091\",\n \"esn\": \"837695\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -59896,57 +59173,23 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 412, "cookie": [], "header": [ { @@ -59954,7 +59197,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -59962,7 +59205,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -59970,57 +59213,23 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -60028,7 +59237,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -60036,7 +59245,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -60044,57 +59253,23 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -60102,7 +59277,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -60110,7 +59285,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -60118,71 +59293,46 @@ "path": [ "organization", ":orgid", - "v3", "dial-number" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", - "key": "includeEntryPointName", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-number", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" } ] - } - ], - "name": "Dial Number" - }, - { - "item": [ + }, { - "name": "List Dial Plan(s)", + "name": "Bulk save Dialed Number Mapping(s)", "request": { - "description": "Retrieve a list of Dial Plan(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60190,31 +59340,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60228,7 +59357,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -60236,15 +59365,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60252,31 +59395,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60285,12 +59407,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -60298,15 +59420,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60314,31 +59450,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60347,28 +59462,42 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "Multi-Status", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60376,31 +59505,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60409,12 +59517,12 @@ ] } }, - "status": "Forbidden" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -60422,15 +59530,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60438,31 +59560,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60471,28 +59572,42 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"name\": \"\u2009\u2004ey\",\n \"regularExpression\": \"\",\n \"organizationId\": \"32C58ce0-7090-3f2f-a6eb404DE63BB4B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"R\u2003k\",\n \"regularExpression\": \"\",\n \"organizationId\": \"03df8127-40e7d5eF-47DED40A9EC897cE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60500,31 +59615,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60533,12 +59627,12 @@ ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -60546,15 +59640,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -60562,31 +59670,10 @@ "path": [ "organization", ":orgid", - "dial-plan" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60595,59 +59682,12 @@ ] } }, - "status": "Not Found" - } - ] - }, - { - "name": "Create a new Dial Plan", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "status": "Unauthorized" }, - "description": "Create a new Dial Plan in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -60655,7 +59695,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -60665,7 +59705,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"15472.4-.16\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"AfCBF38edcbd-028c473F3bFb29B92cDD\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"dialledNumber\": \"3536923289097-910768\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"04CfA51fF92E-992C-c2EF-7747F20a57b2\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -60685,9 +59725,10 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60696,42 +59737,74 @@ ] } }, - "status": "Unauthorized" - }, + "status": "Conflict" + } + ] + }, + { + "name": "Bulk export Dialed Number Mapping(s)", + "request": { + "description": "Export all Dialed Number Mapping(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-number", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -60739,9 +59812,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60750,12 +59836,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -60763,29 +59849,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -60793,9 +59865,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60804,12 +59889,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -60817,29 +59902,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -60847,9 +59918,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60858,42 +59942,28 @@ ] } }, - "status": "Conflict" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"dialledNumber\": \"\",\n \"entryPointName\": \"\",\n \"region\": \"\"\n },\n {\n \"dialledNumber\": \"\",\n \"entryPointName\": \"\",\n \"region\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -60901,9 +59971,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60912,12 +59995,12 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -60925,29 +60008,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -60955,9 +60024,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -60966,12 +60048,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -60979,29 +60061,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61009,9 +60077,22 @@ "path": [ "organization", ":orgid", - "dial-plan" + "dial-number", + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61020,35 +60101,21 @@ ] } }, - "status": "Bad Request" + "status": "Not Found" } ] }, { - "name": "Bulk save Dial Plan(s)", + "name": "List only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Dial Plan(s) in bulk in a given organization.", + "description": "Retrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61056,10 +60123,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61072,8 +60139,8 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "body": "[\n \"\",\n \"\"\n]", + "code": 200, "cookie": [], "header": [ { @@ -61081,84 +60148,15 @@ "value": "*/*" } ], - "name": "Multi-Status", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - "bulk" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Multi-Status (WebDAV) (RFC 4918)" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61166,10 +60164,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61178,12 +60176,12 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -61191,29 +60189,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61221,10 +60205,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61233,12 +60217,12 @@ ] } }, - "status": "Bad Request" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 429, "cookie": [], "header": [ { @@ -61246,29 +60230,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61276,10 +60246,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61288,12 +60258,12 @@ ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -61301,29 +60271,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61331,10 +60287,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61343,12 +60299,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -61356,29 +60312,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61386,10 +60328,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61398,7 +60340,7 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -61413,27 +60355,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -61441,10 +60369,10 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk" + "dial-number", + "numbers-only" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61458,9 +60386,9 @@ ] }, { - "name": "Bulk export Dial Plan(s)", + "name": "Get specific Dialed Number Mapping by ID", "request": { - "description": "Export all Dial Plan(s) in a given organization.", + "description": "Retrieve an existing Dialed Number Mapping by ID in a given organization.", "header": [ { "key": "Accept", @@ -61475,27 +60403,20 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id", + "value": "" } ] } @@ -61504,7 +60425,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -61512,7 +60433,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -61528,36 +60449,28 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -61565,7 +60478,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -61581,49 +60494,41 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -61634,36 +60539,28 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -61671,7 +60568,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -61687,49 +60584,41 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"regularExpression\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\"\n },\n {\n \"name\": \"\",\n \"regularExpression\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -61740,36 +60629,28 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -61777,7 +60658,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -61793,45 +60674,51 @@ "path": [ "organization", ":orgid", - "dial-plan", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "dial-number", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dialed Number Mapping.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Get specific Dial Plan by ID", + "name": "Update specific Dialed Number Mapping by ID", "request": { - "description": "Retrieve an existing Dial Plan by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, + "description": "Update an existing Dialed Number Mapping by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -61839,10 +60726,10 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -61850,7 +60737,7 @@ "value": "" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id", "value": "" } @@ -61861,7 +60748,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 412, "cookie": [], "header": [ { @@ -61869,15 +60756,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -61885,28 +60786,28 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -61914,15 +60815,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -61930,23 +60845,23 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -61961,13 +60876,27 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -61975,17 +60904,17 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] @@ -61996,7 +60925,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -62004,15 +60933,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -62020,289 +60963,28 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Update specific Dial Plan by ID", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Update an existing Dial Plan by ID in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -62310,7 +60992,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -62320,7 +61002,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" }, "header": [ { @@ -62340,23 +61022,23 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -62379,7 +61061,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" }, "header": [ { @@ -62399,17 +61081,17 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] @@ -62420,125 +61102,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "dial-plan", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Dial Plan.", - "key": "id" - } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -62546,7 +61110,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -62556,7 +61120,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" }, "header": [ { @@ -62576,36 +61140,36 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"CFB1eD6b-6EE73D3fAA4A-45648AeAA4BD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+168038410312.\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -62615,7 +61179,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"e14ACc92-c662-1fC4A316-b26DDc888fCA\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"78417.50285--\",\n \"extension\": \"485\",\n \"routingPrefix\": \"489\",\n \"esn\": \"39296\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n}" }, "header": [ { @@ -62624,7 +61188,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "PUT", @@ -62635,30 +61199,30 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Not Found" + "status": "OK" } ] }, { - "name": "Delete specific Dial Plan by ID", + "name": "Delete specific Dialed Number Mapping by ID", "request": { - "description": "Delete an existing Dial Plan by ID in a given organization.", + "description": "Delete an existing Dialed Number Mapping by ID in a given organization.", "header": [ { "key": "Accept", @@ -62673,10 +61237,10 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -62684,7 +61248,7 @@ "value": "" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id", "value": "" } @@ -62695,7 +61259,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 412, "cookie": [], "header": [ { @@ -62703,7 +61267,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -62719,43 +61283,33 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 200, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "OK", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -62764,33 +61318,43 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "OK", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ @@ -62799,28 +61363,28 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -62828,7 +61392,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -62844,23 +61408,23 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -62889,17 +61453,17 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] @@ -62910,7 +61474,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -62918,7 +61482,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -62934,28 +61498,28 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 404, "cookie": [], "header": [ { @@ -62963,7 +61527,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -62979,30 +61543,30 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Dial Plan.", + "description": "Resource ID of the Dialed Number Mapping.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Not Found" } ] }, { - "name": "List references for a specific Dial Plan", + "name": "List references for a specific Dialed Number Mapping", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization.", "header": [ { "key": "Accept", @@ -63017,7 +61581,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63038,7 +61602,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63081,7 +61645,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63102,7 +61666,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63120,7 +61684,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -63128,7 +61692,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -63144,7 +61708,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63165,7 +61729,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63178,12 +61742,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -63191,7 +61755,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -63207,7 +61771,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63228,7 +61792,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63241,25 +61805,25 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -63270,7 +61834,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63291,7 +61855,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63304,25 +61868,25 @@ ] } }, - "status": "OK" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -63333,7 +61897,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63354,7 +61918,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63367,12 +61931,12 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -63380,7 +61944,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -63396,7 +61960,7 @@ "path": [ "organization", ":orgid", - "dial-plan", + "dial-number", ":id", "incoming-references" ], @@ -63417,7 +61981,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63430,14 +61994,14 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "List Dial Plan(s)", + "name": "List Dialed Number Mapping(s)", "request": { - "description": "Retrieve a list of Dial Plan(s) in a given organization.", + "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", "header": [ { "key": "Accept", @@ -63453,21 +62017,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63480,9 +62044,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63496,7 +62065,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -63504,7 +62073,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -63521,21 +62090,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63548,9 +62117,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63559,25 +62133,25 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"WC\\rl\u200avVj\",\n \"regularExpression\": \"\",\n \"organizationId\": \"3d0bf98fE8Fa06Bf-eA25-Ae24B03c5356\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"\\ffkbo\",\n \"regularExpression\": \"\",\n \"organizationId\": \"aeEEAAB2-2947FBDfC5aAaCB31EDB32F2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -63589,21 +62163,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63616,9 +62190,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63627,25 +62206,25 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 6833\n },\n \"data\": [\n {\n \"dialledNumber\": \"662.2\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"d899aD7D-2988-0972-67B7-e329ceE3c752\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"dialledNumber\": \"811177\",\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"f7eFef1C25dC87D919eAcE5a41b09F4f\",\n \"id\": \"\",\n \"version\": \"\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -63657,21 +62236,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63684,9 +62263,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63695,12 +62279,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -63708,7 +62292,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -63725,21 +62309,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63752,9 +62336,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63763,12 +62352,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -63776,7 +62365,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -63793,21 +62382,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63820,9 +62409,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63831,12 +62425,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -63844,7 +62438,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -63861,21 +62455,21 @@ "organization", ":orgid", "v2", - "dial-plan" + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -63888,9 +62482,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63899,19 +62498,14 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" } ] - } - ], - "name": "Dial Plan" - }, - { - "item": [ + }, { - "name": "List Entry Point(s)", + "name": "List Dialed Number Mapping(s)", "request": { - "description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.", "header": [ { "key": "Accept", @@ -63926,27 +62520,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", - "value": "" - }, - { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -63960,12 +62550,12 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -63979,7 +62569,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -63987,7 +62577,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -64003,22 +62593,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -64032,26 +62623,27 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -64059,7 +62651,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -64075,22 +62667,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -64104,39 +62697,40 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": false,\n \"key_1\": 6833\n },\n \"data\": [\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"ace8f28BD9Ca-4F9aceA5-B3aEC76C1b9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+5173398\",\n \"extension\": \"229536140\",\n \"routingPrefix\": \"14979\",\n \"esn\": \"60127986\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n },\n {\n \"entryPointId\": \"\",\n \"entryPointName\": \"\",\n \"organizationId\": \"8eF6c0c1-ef9FBDd6CB6A-deCdC24B6cBD\",\n \"id\": \"\",\n \"version\": \"\",\n \"dialledNumber\": \"+11662747908406507\",\n \"extension\": \"55268\",\n \"routingPrefix\": \"091\",\n \"esn\": \"837695\",\n \"routePointId\": \"\",\n \"defaultAni\": \"\",\n \"location\": \"\",\n \"regionId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"dialledNumberDigits\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -64147,22 +62741,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -64176,39 +62771,40 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"VIDEO\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\ufeff\u20028\",\n \"overflowNumber\": \"47380\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"70b47DDAb02E-BcBB-B8d3fAC3edf4cefa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"OTHERS\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"kd\",\n \"overflowNumber\": \"288\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSENGER\",\n \"organizationId\": \"e0Fd5De2-d990-c7F4D8BE-67c36814Da56\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -64219,22 +62815,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -64248,26 +62845,27 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -64275,7 +62873,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -64291,22 +62889,23 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", - "key": "attributes", + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -64320,21 +62919,22 @@ "value": "100" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -64363,7 +62963,141 @@ "path": [ "organization", ":orgid", - "entry-point" + "v3", + "dial-number" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.", + "key": "includeEntryPointName", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/dial-number?filter=&attributes=&search=&page=0&pageSize=100&includeEntryPointName=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "status": "Forbidden" + } + ] + } + ], + "name": "Dial Number" + }, + { + "item": [ + { + "name": "List Dial Plan(s)", + "request": { + "description": "Retrieve a list of Dial Plan(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" ], "query": [ { @@ -64372,12 +63106,69 @@ "value": "" }, { - "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", - "key": "channelTypes", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -64390,14 +63181,71 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64407,11 +63255,197 @@ } }, "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "[\n {\n \"active\": \"\",\n \"name\": \"o\",\n \"regularExpression\": \"\",\n \"organizationId\": \"8Cc72bD925Cd4A4b-C5ef5EF6d41Ac1Eb\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"_tJ\\n\u180ec k\",\n \"regularExpression\": \"\",\n \"organizationId\": \"6EE40ADA-f09d-1111-6480-0DFaDCCcE10e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "dial-plan" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/dial-plan?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" } ] }, { - "name": "Create a new Entry Point", + "name": "Create a new Dial Plan", "request": { "body": { "mode": "raw", @@ -64421,9 +63455,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, - "description": "Create a new Entry Point in a given organization.", + "description": "Create a new Dial Plan in a given organization.", "header": [ { "key": "Content-Type", @@ -64442,9 +63476,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64458,7 +63492,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -64466,7 +63500,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -64476,7 +63510,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64496,9 +63530,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64507,20 +63541,20 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -64530,7 +63564,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64539,7 +63573,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -64550,9 +63584,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64561,12 +63595,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -64574,7 +63608,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -64584,7 +63618,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64604,9 +63638,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64615,20 +63649,20 @@ ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -64638,7 +63672,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64647,7 +63681,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -64658,9 +63692,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64669,12 +63703,12 @@ ] } }, - "status": "Created" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -64682,7 +63716,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -64692,7 +63726,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64712,9 +63746,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64723,12 +63757,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -64736,7 +63770,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -64746,7 +63780,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64766,9 +63800,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64777,12 +63811,12 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -64790,7 +63824,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -64800,7 +63834,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -64820,9 +63854,9 @@ "path": [ "organization", ":orgid", - "entry-point" + "dial-plan" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64831,12 +63865,12 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] }, { - "name": "Bulk save Entry Point(s)", + "name": "Bulk save Dial Plan(s)", "request": { "body": { "mode": "raw", @@ -64846,9 +63880,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Entry Point(s) in bulk in a given organization.", + "description": "Create, Update or delete Dial Plan(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -64867,10 +63901,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64882,17 +63916,17 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Similar entity is already present", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -64902,7 +63936,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -64911,7 +63945,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -64922,10 +63956,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64934,7 +63968,7 @@ ] } }, - "status": "Conflict" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", @@ -64957,7 +63991,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -64977,10 +64011,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -64994,7 +64028,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -65002,7 +64036,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -65012,7 +64046,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -65032,10 +64066,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65044,12 +64078,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 409, "cookie": [], "header": [ { @@ -65057,7 +64091,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -65067,7 +64101,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -65087,10 +64121,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65099,12 +64133,12 @@ ] } }, - "status": "Forbidden" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -65112,7 +64146,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -65122,7 +64156,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -65142,10 +64176,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65154,12 +64188,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -65167,7 +64201,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -65177,7 +64211,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -65197,10 +64231,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65209,20 +64243,20 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -65232,7 +64266,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u200a_ cwt5N\",\n \"regularExpression\": \"\",\n \"organizationId\": \"b8d5CABd-91ADb2c2-39ECDa8Fc911DCDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"A\",\n \"regularExpression\": \"\",\n \"organizationId\": \"E3bCfe8edfF099e7f87Cc332e5d5b4ec\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -65241,7 +64275,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -65252,10 +64286,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65264,14 +64298,14 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Internal Server Error" } ] }, { - "name": "Bulk export Entry Point(s)", + "name": "Bulk export Dial Plan(s)", "request": { - "description": "Export all Entry Point(s) in a given organization.", + "description": "Export all Dial Plan(s) in a given organization.", "header": [ { "key": "Accept", @@ -65286,15 +64320,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65303,10 +64332,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65320,7 +64349,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -65328,7 +64357,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -65344,15 +64373,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65361,10 +64385,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65373,25 +64397,25 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"timezone\": \"\",\n \"channelType\": \"\",\n \"socialChannelType\": \"\",\n \"entryPointType\": \"\",\n \"assetId\": \"\",\n \"flowId\": \"\",\n \"flowTag\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"callbackEnabled\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"timezone\": \"\",\n \"channelType\": \"\",\n \"socialChannelType\": \"\",\n \"entryPointType\": \"\",\n \"assetId\": \"\",\n \"flowId\": \"\",\n \"flowTag\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"callbackEnabled\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -65402,15 +64426,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65419,10 +64438,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65431,12 +64450,12 @@ ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -65444,7 +64463,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -65460,15 +64479,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65477,10 +64491,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65489,12 +64503,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -65502,7 +64516,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -65518,15 +64532,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65535,10 +64544,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65547,25 +64556,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"regularExpression\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\"\n },\n {\n \"name\": \"\",\n \"regularExpression\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -65576,15 +64585,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65593,10 +64597,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65605,12 +64609,12 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -65618,7 +64622,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -65634,15 +64638,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", "bulk-export" ], "query": [ - { - "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", - "key": "type", - "value": "INBOUND" - }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -65651,10 +64650,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -65663,21 +64662,21 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] }, { - "name": "Purge inactive Entry Point(s)", + "name": "Get specific Dial Plan by ID", "request": { - "description": "Purge inactive Entry Point(s) older than the configured interval for a given organization.", + "description": "Retrieve an existing Dial Plan by ID in a given organization.", "header": [ { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65685,22 +64684,20 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id", + "value": "" } ] } @@ -65709,7 +64706,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -65717,7 +64714,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -65725,7 +64722,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65733,31 +64730,28 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -65765,7 +64759,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -65773,7 +64767,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65781,26 +64775,23 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -65821,7 +64812,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65829,21 +64820,18 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } @@ -65853,7 +64841,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -65861,7 +64849,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -65869,7 +64857,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65877,30 +64865,27 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -65917,7 +64902,7 @@ "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65925,21 +64910,18 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } @@ -65949,7 +64931,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -65957,7 +64939,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -65965,7 +64947,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -65973,88 +64955,51 @@ "path": [ "organization", ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "dial-plan", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", - "variable": [ + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the Dial Plan.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] }, { - "name": "Get specific Entry Point by ID", + "name": "Update specific Dial Plan by ID", "request": { - "description": "Retrieve an existing Entry Point by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Update an existing Dial Plan by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -66062,17 +65007,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -66080,7 +65018,7 @@ "value": "" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id", "value": "" } @@ -66088,217 +65026,9 @@ } }, "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"name\": \"k\u2000k\u2001-\",\n \"regularExpression\": \"\",\n \"organizationId\": \"c7bcCbA1-2203-727CDecf-f2bFBC40a1c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -66308,163 +65038,6 @@ } ], "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "query": [ - { - "description": "Specifiy whether to include flow override settings reference variable names.", - "key": "includeNames", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Update specific Entry Point by ID", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" - }, - "description": "Update an existing Entry Point by ID in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "entry-point", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Entry Point.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -66474,7 +65047,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66483,7 +65056,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "PUT", @@ -66494,28 +65067,28 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -66523,7 +65096,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -66533,7 +65106,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66553,23 +65126,23 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -66592,7 +65165,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66612,17 +65185,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -66651,7 +65224,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66671,17 +65244,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -66692,7 +65265,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -66700,7 +65273,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -66710,7 +65283,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66730,23 +65303,23 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -66769,7 +65342,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66789,17 +65362,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -66808,17 +65381,17 @@ "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -66828,7 +65401,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66837,7 +65410,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "PUT", @@ -66848,28 +65421,28 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -66877,7 +65450,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -66887,7 +65460,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u200a\u1680\",\n \"regularExpression\": \"\",\n \"organizationId\": \"DF1847Ef-A4E30556f63c-ca1BaEfFF5F7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -66907,30 +65480,30 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" } ] }, { - "name": "Delete specific Entry Point by ID", + "name": "Delete specific Dial Plan by ID", "request": { - "description": "Delete an existing Entry Point by ID in a given organization.", + "description": "Delete an existing Dial Plan by ID in a given organization.", "header": [ { "key": "Accept", @@ -66945,10 +65518,10 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -66956,7 +65529,7 @@ "value": "" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id", "value": "" } @@ -66991,17 +65564,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -67036,17 +65609,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -67057,10 +65630,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 200, "cookie": [], "header": [], - "name": "No Content", + "name": "OK", "originalRequest": { "header": [], "method": "DELETE", @@ -67071,28 +65644,28 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "No Content" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 429, "cookie": [], "header": [ { @@ -67100,7 +65673,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -67116,28 +65689,28 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -67145,7 +65718,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -67161,23 +65734,23 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -67206,17 +65779,17 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] @@ -67227,7 +65800,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -67235,7 +65808,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -67251,30 +65824,30 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Entry Point.", + "description": "Resource ID of the Dial Plan.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" } ] }, { - "name": "List references for a specific Entry Point", + "name": "List references for a specific Dial Plan", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization.", "header": [ { "key": "Accept", @@ -67289,7 +65862,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67310,7 +65883,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67329,7 +65902,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -67337,7 +65910,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -67353,7 +65926,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67374,7 +65947,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67387,12 +65960,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -67400,7 +65973,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -67416,7 +65989,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67437,7 +66010,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67450,12 +66023,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -67463,7 +66036,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -67479,7 +66052,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67500,7 +66073,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67513,25 +66086,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -67542,7 +66115,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67563,7 +66136,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67576,12 +66149,12 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -67589,7 +66162,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -67605,7 +66178,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67626,7 +66199,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67639,25 +66212,25 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -67668,7 +66241,7 @@ "path": [ "organization", ":orgid", - "entry-point", + "dial-plan", ":id", "incoming-references" ], @@ -67689,7 +66262,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67702,14 +66275,14 @@ ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "List Entry Point(s)", + "name": "List Dial Plan(s)", "request": { - "description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Dial Plan(s) in a given organization.", "header": [ { "key": "Accept", @@ -67725,21 +66298,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -67752,29 +66325,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67786,22 +66339,22 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"xa\u2001\u2029GX\",\n \"overflowNumber\": \"584790435\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"4e1eE1ac9B6D-07cc-7f56-0C6AAb49b2A3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u202fQO\u2005\ufeff1\",\n \"overflowNumber\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"01596c02-DBD8fee061bE9e2DBBFA0EA0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -67813,21 +66366,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -67840,29 +66393,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67871,25 +66404,25 @@ ] } }, - "status": "OK" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"WC\\rl\u200avVj\",\n \"regularExpression\": \"\",\n \"organizationId\": \"3d0bf98fE8Fa06Bf-eA25-Ae24B03c5356\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"\\ffkbo\",\n \"regularExpression\": \"\",\n \"organizationId\": \"aeEEAAB2-2947FBDfC5aAaCB31EDB32F2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"prefix\": \"\",\n \"strippedChars\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -67901,21 +66434,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -67928,29 +66461,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -67959,12 +66472,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -67972,7 +66485,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -67989,21 +66502,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -68016,29 +66529,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68047,7 +66540,7 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -68077,21 +66570,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -68104,29 +66597,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68140,7 +66613,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -68148,7 +66621,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -68165,21 +66638,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -68192,29 +66665,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68223,7 +66676,7 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -68253,21 +66706,21 @@ "organization", ":orgid", "v2", - "entry-point" + "dial-plan" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -68280,29 +66733,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", - "key": "desktopProfileFilter", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, - { - "description": "Enable the flag to get the count of DN-EP Mapping", - "key": "includeCount", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/dial-plan?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68316,35 +66749,21 @@ ] } ], - "name": "Entry Point" + "name": "Dial Plan" }, { "item": [ { - "name": "Create a new Global Variable", + "name": "List Entry Point(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Create a new Global Variable in a given organization.", + "description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68352,9 +66771,46 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68366,39 +66822,25 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -68406,9 +66848,41 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68417,12 +66891,12 @@ ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -68430,7 +66904,414 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": "[\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"VIDEO\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u202f\u180e\u20285Dx\u2009Y\",\n \"overflowNumber\": \"722357459\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"1098AAaC7258e2Ea-FA607B6c3DebA7ba\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"VIDEO\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"x\\nmF\",\n \"overflowNumber\": \"9832\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"BF2eEa80bD13-Ba23438E18Bbe1Ab6Dc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.", + "key": "channelTypes", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point?filter=&channelTypes=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Create a new Entry Point", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Create a new Entry Point in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -68440,7 +67321,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68460,9 +67341,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68471,12 +67352,12 @@ ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -68484,7 +67365,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -68494,7 +67375,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68514,9 +67395,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68525,12 +67406,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -68538,7 +67419,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -68548,7 +67429,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68568,9 +67449,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68579,12 +67460,66 @@ ] } }, - "status": "Bad Request" + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "entry-point" + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -68592,7 +67527,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -68602,7 +67537,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68622,9 +67557,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68633,12 +67568,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -68646,7 +67581,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -68656,7 +67591,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68676,9 +67611,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68687,12 +67622,12 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -68700,7 +67635,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -68710,7 +67645,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68730,9 +67665,9 @@ "path": [ "organization", ":orgid", - "cad-variable" + "entry-point" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "raw": "{{baseUrl}}/organization/:orgid/entry-point", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68741,12 +67676,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" } ] }, { - "name": "Bulk save Global Variable(s)", + "name": "Bulk save Entry Point(s)", "request": { "body": { "mode": "raw", @@ -68756,9 +67691,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Export all Global Variable(s) in a given organization.", + "description": "Create, Update or delete Entry Point(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -68777,10 +67712,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68794,7 +67729,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 409, "cookie": [], "header": [ { @@ -68802,7 +67737,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -68812,7 +67747,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68832,10 +67767,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68844,12 +67779,12 @@ ] } }, - "status": "Forbidden" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -68857,7 +67792,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -68867,7 +67802,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68887,10 +67822,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68899,20 +67834,20 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -68922,7 +67857,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68931,7 +67866,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -68942,10 +67877,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -68954,12 +67889,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -68967,7 +67902,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -68977,7 +67912,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -68997,10 +67932,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69009,12 +67944,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -69022,7 +67957,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -69032,7 +67967,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -69052,10 +67987,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69064,7 +67999,7 @@ ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -69087,7 +68022,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -69107,10 +68042,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69122,17 +68057,17 @@ "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -69142,7 +68077,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"TELEPHONY\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u2005Hq\",\n \"overflowNumber\": \"28849\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"be907feCBe870873-7aFE-001f6Bd69a7a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"2f\",\n \"overflowNumber\": \"082\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"3EaE7fd7F9DedE50-bC4c-C6AdC2D9f80b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -69151,7 +68086,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -69162,10 +68097,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69174,14 +68109,14 @@ ] } }, - "status": "Unauthorized" + "status": "Multi-Status (WebDAV) (RFC 4918)" } ] }, { - "name": "Bulk export Global Variable(s)", + "name": "Bulk export Entry Point(s)", "request": { - "description": "Export all Global Variable(s) in a given organization.", + "description": "Export all Entry Point(s) in a given organization.", "header": [ { "key": "Accept", @@ -69196,10 +68131,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69211,7 +68151,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69225,7 +68165,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -69233,7 +68173,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -69249,10 +68189,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69264,7 +68209,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69273,25 +68218,25 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"timezone\": \"\",\n \"channelType\": \"\",\n \"socialChannelType\": \"\",\n \"entryPointType\": \"\",\n \"assetId\": \"\",\n \"flowId\": \"\",\n \"flowTag\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"callbackEnabled\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"timezone\": \"\",\n \"channelType\": \"\",\n \"socialChannelType\": \"\",\n \"entryPointType\": \"\",\n \"assetId\": \"\",\n \"flowId\": \"\",\n \"flowTag\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"callbackEnabled\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -69302,10 +68247,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69317,7 +68267,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69326,25 +68276,25 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"agentEditable\": \"\",\n \"variableType\": \"BOOLEAN\",\n \"defaultValue\": \"\",\n \"reportable\": \"\",\n \"sensitive\": \"\",\n \"agentViewable\": \"\",\n \"desktopLabel\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"agentEditable\": \"\",\n \"variableType\": \"Boolean\",\n \"defaultValue\": \"\",\n \"reportable\": \"\",\n \"sensitive\": \"\",\n \"agentViewable\": \"\",\n \"desktopLabel\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -69355,10 +68305,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69370,7 +68325,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69379,7 +68334,7 @@ ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -69408,10 +68363,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69423,7 +68383,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69437,7 +68397,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -69445,7 +68405,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -69461,10 +68421,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69476,7 +68441,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69485,12 +68450,12 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -69498,7 +68463,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -69514,10 +68479,15 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "bulk-export" ], "query": [ + { + "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.", + "key": "type", + "value": "INBOUND" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -69529,7 +68499,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export?type=INBOUND&page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69538,14 +68508,14 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" } ] }, { - "name": "Purge inactive Global Variable(s)", + "name": "Purge inactive Entry Point(s)", "request": { - "description": "Purge inactive Global Variable(s) older than the configured interval for a given organization.", + "description": "Purge inactive Entry Point(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -69560,7 +68530,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69570,7 +68540,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69582,22 +68552,22 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Similar entity is already present", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -69608,7 +68578,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69618,7 +68588,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69627,12 +68597,12 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -69640,7 +68610,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -69656,7 +68626,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69666,7 +68636,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69675,12 +68645,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -69688,7 +68658,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -69704,7 +68674,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69714,7 +68684,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69723,12 +68693,12 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -69736,7 +68706,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -69752,7 +68722,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69762,7 +68732,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69771,25 +68741,25 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Similar entity is already present", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -69800,7 +68770,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69810,7 +68780,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69819,12 +68789,12 @@ ] } }, - "status": "Conflict" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -69832,7 +68802,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -69848,7 +68818,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69858,7 +68828,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69867,12 +68837,12 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -69880,7 +68850,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -69896,7 +68866,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", "purge-inactive-entities" ], "query": [ @@ -69906,7 +68876,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -69915,14 +68885,14 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" } ] }, { - "name": "Get reportable count for Global Variable(s)", + "name": "Get specific Entry Point by ID", "request": { - "description": "Get count for all the reportable Global Variable(s) in a given organization.", + "description": "Retrieve an existing Entry Point by ID in a given organization.", "header": [ { "key": "Accept", @@ -69937,15 +68907,27 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id", + "value": "" } ] } @@ -69954,7 +68936,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -69962,7 +68944,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -69978,24 +68960,35 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -70003,7 +68996,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -70019,24 +69012,35 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -70044,7 +69048,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -70060,19 +69064,30 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -70101,14 +69116,25 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } @@ -70117,7 +69143,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"key_0\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -70142,14 +69168,25 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } @@ -70183,14 +69220,25 @@ "path": [ "organization", ":orgid", - "cad-variable", - "reportable-count" + "entry-point", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", + "query": [ + { + "description": "Specifiy whether to include flow override settings reference variable names.", + "key": "includeNames", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id?includeNames=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Entry Point.", + "key": "id" } ] } @@ -70200,16 +69248,30 @@ ] }, { - "name": "Get specific Global Variable by ID", + "name": "Update specific Entry Point by ID", "request": { - "description": "Retrieve an existing Global Variable by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, + "description": "Update an existing Entry Point by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70217,10 +69279,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -70228,7 +69290,7 @@ "value": "" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id", "value": "" } @@ -70239,7 +69301,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -70247,105 +69309,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -70353,17 +69339,17 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] @@ -70371,194 +69357,6 @@ }, "status": "Unauthorized" }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - } - ] - }, - { - "name": "Update specific Global Variable by ID", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "ID of the Global Variable.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -70580,7 +69378,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70600,17 +69398,17 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] @@ -70621,7 +69419,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 500, "cookie": [], "header": [ { @@ -70629,7 +69427,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -70639,7 +69437,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70659,28 +69457,28 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -70688,7 +69486,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -70698,7 +69496,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70718,28 +69516,28 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -70747,7 +69545,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -70757,7 +69555,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70777,28 +69575,28 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 412, "cookie": [], "header": [ { @@ -70806,7 +69604,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -70816,7 +69614,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70836,27 +69634,27 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"SOCIAL_CHANNEL\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"-Pdh\\n\u2006\",\n \"overflowNumber\": \"894141\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"6B0E7c2F71CE-436Da28b-FDdFbB6d4e68\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -70875,7 +69673,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -70895,17 +69693,17 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] @@ -70916,66 +69714,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "cad-variable", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the Global Variable.", - "key": "id" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -70983,7 +69722,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -70993,7 +69732,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"M\u205f\",\n \"overflowNumber\": \"443\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"GOOGLE_BUSINESS_MESSAGES\",\n \"organizationId\": \"ACf3E0AF-c3EB-E00c1Cb2-9EFc9a7fCAB9\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, "header": [ { @@ -71013,30 +69752,30 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Delete specific Global Variable by ID", + "name": "Delete specific Entry Point by ID", "request": { - "description": "Delete an existing Global Variable by ID in a given organization.", + "description": "Delete an existing Entry Point by ID in a given organization.", "header": [ { "key": "Accept", @@ -71051,10 +69790,10 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71062,7 +69801,7 @@ "value": "" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id", "value": "" } @@ -71073,7 +69812,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -71081,7 +69820,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -71097,28 +69836,28 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -71126,7 +69865,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -71142,43 +69881,33 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", + "header": [], + "name": "No Content", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -71187,28 +69916,28 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Not Found" + "status": "No Content" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 412, "cookie": [], "header": [ { @@ -71216,7 +69945,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -71232,23 +69961,23 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", @@ -71277,17 +70006,17 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] @@ -71298,7 +70027,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -71306,7 +70035,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -71322,33 +70051,43 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "OK", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ @@ -71357,30 +70096,30 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the Global Variable.", + "description": "Resource ID of the Entry Point.", "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" } ] }, { - "name": "List references for a specific Global Variable", + "name": "List references for a specific Entry Point", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.", "header": [ { "key": "Accept", @@ -71395,7 +70134,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71416,7 +70155,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71459,7 +70198,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71480,7 +70219,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71498,7 +70237,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -71506,7 +70245,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -71522,7 +70261,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71543,7 +70282,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71556,25 +70295,25 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -71585,7 +70324,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71606,7 +70345,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71619,12 +70358,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -71632,7 +70371,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -71648,7 +70387,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71669,7 +70408,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71682,12 +70421,12 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -71695,7 +70434,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -71711,7 +70450,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71732,7 +70471,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71745,25 +70484,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -71774,7 +70513,7 @@ "path": [ "organization", ":orgid", - "cad-variable", + "entry-point", ":id", "incoming-references" ], @@ -71795,7 +70534,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71808,14 +70547,14 @@ ] } }, - "status": "Not Found" + "status": "OK" } ] }, { - "name": "List Global Variable(s)", + "name": "List Entry Point(s)", "request": { - "description": "Retrieve a list of Global Variable(s) in a given organization.", + "description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", @@ -71831,21 +70570,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -71858,9 +70597,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71873,7 +70632,7 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WZEbWY\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"8c62b2f67Ab8-F3eE-70e9-895791F25d5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"P2\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"1abcA16E-13BcAc81bf6F-8AA017Bdfe21\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"FAX\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"INBOUND\",\n \"imiOrgType\": \"IMI\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"xa\u2001\u2029GX\",\n \"overflowNumber\": \"584790435\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"MESSAGEBIRD\",\n \"organizationId\": \"4e1eE1ac9B6D-07cc-7f56-0C6AAb49b2A3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"assetId\": \"\",\n \"channelType\": \"CHAT\",\n \"controlFlowScriptUrl\": \"\",\n \"entryPointType\": \"OUTBOUND\",\n \"imiOrgType\": \"MIXED_MODE\",\n \"maximumActiveContacts\": \"\",\n \"name\": \"\u202fQO\u2005\ufeff1\",\n \"overflowNumber\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"socialChannelType\": \"WHATSAPP\",\n \"organizationId\": \"01596c02-DBD8fee061bE9e2DBBFA0EA0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"routePointId\": \"\",\n \"flowId\": \"\",\n \"flowTagId\": \"\",\n \"musicOnHoldId\": \"\",\n \"outdialQueueId\": \"\",\n \"systemDefault\": \"\",\n \"callbackEnabled\": \"\",\n \"outdialTransferToQueueEnabled\": \"\",\n \"dnEpMappingCount\": \"\",\n \"flowOverrideSettings\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"entityId\": \"\",\n \"value\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -71899,21 +70658,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -71926,9 +70685,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -71942,7 +70721,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -71950,7 +70729,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -71967,21 +70746,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -71994,9 +70773,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72005,12 +70804,12 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -72018,7 +70817,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -72035,21 +70834,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -72062,9 +70861,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72073,12 +70892,12 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -72086,7 +70905,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -72103,21 +70922,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -72130,9 +70949,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72141,12 +70980,12 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -72154,7 +70993,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -72171,21 +71010,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -72198,9 +71037,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72209,12 +71068,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -72222,7 +71081,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -72239,21 +71098,21 @@ "organization", ":orgid", "v2", - "cad-variable" + "entry-point" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -72266,9 +71125,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.", + "key": "desktopProfileFilter", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", + "key": "provisioningView", + "value": "false" + }, + { + "description": "Enable the flag to get the count of DN-EP Mapping", + "key": "includeCount", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/entry-point?filter=&attributes=&search=&page=0&pageSize=100&desktopProfileFilter=false&provisioningView=false&includeCount=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72277,26 +71156,40 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" } ] } ], - "name": "Global Variables" + "name": "Entry Point" }, { "item": [ { - "name": "List Multimedia Profile(s)", + "name": "Create a new Global Variable", "request": { - "description": "Retrieve a list of Multimedia Profile(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Create a new Global Variable in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -72304,31 +71197,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72340,25 +71211,39 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -72366,31 +71251,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72399,12 +71262,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -72412,15 +71275,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -72428,381 +71305,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile" + "cad-variable" ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6\u2009\\r-\u00a0l\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"c041e8ce-5CCC2F42ebE7-1c6756fccBcA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"96da8287Ee06-ab8dCa39Ecd8B14DaF1c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"xI\u2003l\u2008_n\u202fG\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"2ceEDACf-23C8f9B2-069BB81897ECA8aC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"74FfB3D948E6-7fD2-F64d-Db0b3046FeF8\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Forbidden" - } - ] - }, - { - "name": "Create a new Multimedia Profile", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, - "description": "Create a new Multimedia Profile in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", - "variable": [ + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", + "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" @@ -72810,12 +71316,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -72823,7 +71329,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -72833,7 +71339,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -72853,63 +71359,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" - ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "multimedia-profile" + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72918,12 +71370,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -72931,7 +71383,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -72941,7 +71393,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -72961,9 +71413,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -72972,12 +71424,12 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -72985,7 +71437,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -72995,7 +71447,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -73015,9 +71467,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73026,12 +71478,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -73039,7 +71491,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -73049,7 +71501,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -73069,9 +71521,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73080,7 +71532,7 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -73103,7 +71555,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -73123,9 +71575,9 @@ "path": [ "organization", ":orgid", - "multimedia-profile" + "cad-variable" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73139,7 +71591,7 @@ ] }, { - "name": "Bulk save Multimedia Profile(s)", + "name": "Bulk save Global Variable(s)", "request": { "body": { "mode": "raw", @@ -73149,9 +71601,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Multimedia Profile(s) in bulk in a given organization.", + "description": "Export all Global Variable(s) in a given organization.", "header": [ { "key": "Content-Type", @@ -73170,10 +71622,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73205,7 +71657,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73225,10 +71677,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73242,7 +71694,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 429, "cookie": [], "header": [ { @@ -73250,7 +71702,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -73260,7 +71712,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73280,10 +71732,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73292,7 +71744,7 @@ ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", @@ -73315,7 +71767,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73335,10 +71787,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73352,7 +71804,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -73360,7 +71812,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -73370,7 +71822,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73390,10 +71842,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73402,12 +71854,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 409, "cookie": [], "header": [ { @@ -73415,7 +71867,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -73425,7 +71877,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73445,10 +71897,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73457,12 +71909,12 @@ ] } }, - "status": "Unauthorized" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -73470,7 +71922,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -73480,7 +71932,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73500,10 +71952,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73512,12 +71964,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -73525,7 +71977,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -73535,7 +71987,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WqS\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"8d8500C7-cf5B359ef31D-77aC6cfdD6e2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"aFjGYso\",\n \"reportable\": \"\",\n \"variableType\": \"Integer\",\n \"organizationId\": \"FfEaeD09FC27ec72-2fFD71d55DECDcC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -73555,10 +72007,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73567,14 +72019,14 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" } ] }, { - "name": "Bulk export Multimedia Profile(s)", + "name": "Bulk export Global Variable(s)", "request": { - "description": "Export all Multimedia Profile(s) in a given organization.", + "description": "Export all Global Variable(s) in a given organization.", "header": [ { "key": "Accept", @@ -73589,7 +72041,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73601,10 +72053,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73642,7 +72094,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73654,10 +72106,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73695,7 +72147,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73707,10 +72159,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73722,22 +72174,22 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"agentEditable\": \"\",\n \"variableType\": \"BOOLEAN\",\n \"defaultValue\": \"\",\n \"reportable\": \"\",\n \"sensitive\": \"\",\n \"agentViewable\": \"\",\n \"desktopLabel\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"agentEditable\": \"\",\n \"variableType\": \"Boolean\",\n \"defaultValue\": \"\",\n \"reportable\": \"\",\n \"sensitive\": \"\",\n \"agentViewable\": \"\",\n \"desktopLabel\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -73748,7 +72200,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73760,10 +72212,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73772,25 +72224,25 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"telephony\": \"\",\n \"video\": \"\",\n \"social\": \"\",\n \"others\": \"\",\n \"active\": \"\",\n \"blendingModeEnabled\": \"\",\n \"blendingMode\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"dbEcf8b3-1e9A7A61-E11dDEAb87FD0EAC\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"telephony\": \"\",\n \"video\": \"\",\n \"social\": \"\",\n \"others\": \"\",\n \"active\": \"\",\n \"blendingModeEnabled\": \"\",\n \"blendingMode\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"5eB8aA3C-A5c0-C5884348-1F6795D22DDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -73801,7 +72253,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73813,10 +72265,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73825,12 +72277,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -73838,7 +72290,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -73854,7 +72306,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73866,10 +72318,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73878,12 +72330,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -73891,7 +72343,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -73907,7 +72359,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "bulk-export" ], "query": [ @@ -73919,10 +72371,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73931,14 +72383,14 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" } ] }, { - "name": "Purge inactive Multimedia Profile(s)", + "name": "Purge inactive Global Variable(s)", "request": { - "description": "Purge inactive Multimedia Profile(s) older than the configured interval for a given organization.", + "description": "Purge inactive Global Variable(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -73953,7 +72405,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -73963,7 +72415,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -73975,22 +72427,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -74001,7 +72453,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74011,7 +72463,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74020,25 +72472,25 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -74049,7 +72501,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74059,7 +72511,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74068,12 +72520,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -74081,7 +72533,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -74097,7 +72549,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74107,7 +72559,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74116,12 +72568,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 429, "cookie": [], "header": [ { @@ -74129,7 +72581,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -74145,7 +72597,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74155,7 +72607,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74164,12 +72616,12 @@ ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -74177,7 +72629,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Similar entity is already present", "originalRequest": { "header": [ { @@ -74193,7 +72645,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74203,7 +72655,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74212,12 +72664,12 @@ ] } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -74225,7 +72677,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -74241,7 +72693,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74251,7 +72703,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74260,12 +72712,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -74273,7 +72725,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -74289,7 +72741,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", "purge-inactive-entities" ], "query": [ @@ -74299,7 +72751,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74308,14 +72760,14 @@ ] } }, - "status": "Internal Server Error" + "status": "Bad Request" } ] }, { - "name": "Get specific Multimedia Profile by ID", + "name": "Get reportable count for Global Variable(s)", "request": { - "description": "Retrieve an existing Multimedia Profile by ID in a given organization.", + "description": "Get count for all the reportable Global Variable(s) in a given organization.", "header": [ { "key": "Accept", @@ -74330,20 +72782,15 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id", - "value": "" } ] } @@ -74352,7 +72799,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -74360,7 +72807,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -74376,28 +72823,24 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -74405,7 +72848,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -74421,41 +72864,37 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -74466,28 +72905,24 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -74495,7 +72930,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -74511,41 +72946,37 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -74556,28 +72987,24 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -74585,7 +73012,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -74601,51 +73028,33 @@ "path": [ "organization", ":orgid", - "multimedia-profile", - ":id" + "cad-variable", + "reportable-count" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Multimedia Profile.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" } ] }, { - "name": "Update specific Multimedia Profile by ID", + "name": "Get specific Global Variable by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, - "description": "Update an existing Multimedia Profile by ID in a given organization.", + "description": "Retrieve an existing Global Variable by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74653,10 +73062,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -74664,7 +73073,7 @@ "value": "" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id", "value": "" } @@ -74675,7 +73084,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -74683,29 +73092,15 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74713,58 +73108,44 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74772,23 +73153,23 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -74803,27 +73184,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74831,17 +73198,17 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] @@ -74852,7 +73219,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -74860,29 +73227,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74890,58 +73243,44 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -74949,28 +73288,28 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -74978,7 +73317,105 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Update specific Global Variable by ID", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of the Global Variable.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -74988,7 +73425,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -75008,28 +73445,28 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 412, "cookie": [], "header": [ { @@ -75037,7 +73474,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -75047,7 +73484,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -75067,23 +73504,23 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", @@ -75106,7 +73543,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -75126,30 +73563,325 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"zx\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"7d20ce4b-A5Cb-BdCB-79DC080b5fC02005\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"sFZe\",\n \"reportable\": \"\",\n \"variableType\": \"STRING\",\n \"organizationId\": \"0DA4a9Dd-9C7C59aE-2b03-9aA55dFa2Fac\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "cad-variable", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the Global Variable.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" } ] }, { - "name": "Delete specific Multimedia Profile by ID", + "name": "Delete specific Global Variable by ID", "request": { - "description": "Delete an existing Multimedia Profile by ID in a given organization.", + "description": "Delete an existing Global Variable by ID in a given organization.", "header": [ { "key": "Accept", @@ -75164,10 +73896,10 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75175,7 +73907,7 @@ "value": "" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id", "value": "" } @@ -75210,17 +73942,17 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] @@ -75231,7 +73963,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -75239,7 +73971,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -75255,28 +73987,28 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -75284,7 +74016,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -75300,28 +74032,28 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -75329,7 +74061,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -75345,28 +74077,28 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -75374,7 +74106,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -75390,23 +74122,23 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -75435,17 +74167,17 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] @@ -75470,17 +74202,17 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Multimedia Profile.", + "description": "ID of the Global Variable.", "key": "id" } ] @@ -75491,9 +74223,9 @@ ] }, { - "name": "List references for a specific Multimedia Profile", + "name": "List references for a specific Global Variable", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization.", "header": [ { "key": "Accept", @@ -75508,7 +74240,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75529,7 +74261,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75548,7 +74280,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -75556,7 +74288,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -75572,7 +74304,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75593,7 +74325,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75606,12 +74338,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -75619,7 +74351,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -75635,7 +74367,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75656,7 +74388,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75669,25 +74401,25 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -75698,7 +74430,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75719,7 +74451,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75732,12 +74464,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -75745,7 +74477,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -75761,7 +74493,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75782,7 +74514,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75795,12 +74527,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -75808,7 +74540,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -75824,7 +74556,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75845,7 +74577,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75858,25 +74590,25 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -75887,7 +74619,7 @@ "path": [ "organization", ":orgid", - "multimedia-profile", + "cad-variable", ":id", "incoming-references" ], @@ -75908,7 +74640,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75921,14 +74653,14 @@ ] } }, - "status": "OK" + "status": "Not Found" } ] }, { - "name": "List Multimedia Profile(s)", + "name": "List Global Variable(s)", "request": { - "description": "Retrieve a list of Multimedia Profile(s) in a given organization.", + "description": "Retrieve a list of Global Variable(s) in a given organization.", "header": [ { "key": "Accept", @@ -75944,7 +74676,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -75958,7 +74690,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -75973,7 +74705,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -75985,22 +74717,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"WZEbWY\",\n \"reportable\": \"\",\n \"variableType\": \"INTEGER\",\n \"organizationId\": \"8c62b2f67Ab8-F3eE-70e9-895791F25d5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"agentEditable\": \"\",\n \"agentViewable\": \"\",\n \"defaultValue\": \"\",\n \"name\": \"P2\",\n \"reportable\": \"\",\n \"variableType\": \"DateTime\",\n \"organizationId\": \"1abcA16E-13BcAc81bf6F-8AA017Bdfe21\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"sensitive\": \"\",\n \"desktopLabel\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -76012,7 +74744,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76026,7 +74758,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76041,7 +74773,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76050,12 +74782,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -76063,7 +74795,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -76080,7 +74812,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76094,7 +74826,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76109,7 +74841,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76118,12 +74850,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -76131,7 +74863,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -76148,7 +74880,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76162,7 +74894,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76177,7 +74909,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76186,12 +74918,12 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -76199,7 +74931,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -76216,7 +74948,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76230,7 +74962,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76245,7 +74977,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76254,25 +74986,25 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"k\u2007zP\u2004\\rc\u2001_w\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C0d5c8bd-Fdd016DB-A7c7-1d97A384d14A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"3d8Ecd6fE5E5-a11E-624a-4c0c9F76b41A\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"g.\u202fe\u2004u\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"B4BEbcd072Bc8fec0Bed-F5dAccdAE60b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"78ED7ce8-3bc5B4bA82ee-011cbB5AE4AA\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -76284,7 +75016,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76298,7 +75030,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76313,7 +75045,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76322,12 +75054,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -76335,7 +75067,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -76352,7 +75084,7 @@ "organization", ":orgid", "v2", - "multimedia-profile" + "cad-variable" ], "query": [ { @@ -76366,7 +75098,7 @@ "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -76381,7 +75113,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/cad-variable?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76390,19 +75122,19 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" } ] } ], - "name": "Multimedia Profile" + "name": "Global Variables" }, { "item": [ { - "name": "List Outdial ANI(s)", + "name": "List Multimedia Profile(s)", "request": { - "description": "Retrieve a list of Outdial ANI(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Multimedia Profile(s) in a given organization.", "header": [ { "key": "Accept", @@ -76417,7 +75149,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76426,7 +75158,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76439,14 +75171,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76460,7 +75187,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -76468,7 +75195,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -76484,7 +75211,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76493,7 +75220,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76506,14 +75233,71 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "multimedia-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76522,7 +75306,7 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -76551,7 +75335,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76560,7 +75344,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76573,14 +75357,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76592,22 +75371,22 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"4\u2028v\\n\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4a4F6D2DFaAd0Ee418D4b9fe90E90C12\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"afce6Ba3-62bE8De2-5fA3-b22A8f4Ff5B7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u2005r\u20022\\r5thqf\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"24a6BC9c-437D-D5EcCDFe-8F2ea104ad8A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C11c3DDF01f80bA10E2bbf77B2633F8C\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -76618,7 +75397,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76627,7 +75406,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76640,14 +75419,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76656,12 +75430,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -76669,7 +75443,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -76685,74 +75459,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", - "key": "attributes", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"name\": \"P\",\n \"organizationId\": \"0cc14ca3-40f3-65308edE-88128A22900D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"xNT\\t2\",\n \"number\": \"\",\n \"organizationId\": \"896d2da5-B83d-76b9-7D7C-dd8e28ddAAdC\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"I\",\n \"number\": \"\",\n \"organizationId\": \"d6f1B643Adc6-243f7BBcdc1A248EF610\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\f\u00a0H\u2004\u2028wy\u1680\u2000\",\n \"organizationId\": \"D9E92486-8765-54B810AA-6e9FAdb8C25E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"HP2\u20090\u2028\u2009\",\n \"number\": \"\",\n \"organizationId\": \"3cad5cDc-358e-89Ed-5dD2dbb4a0fb2E95\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"hi\u20067uTkpC\u2006\",\n \"number\": \"\",\n \"organizationId\": \"6dcfdb1C-9fcdD00D8F69-67a9e5EcCEb3\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76761,7 +75468,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76774,14 +75481,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76790,12 +75492,12 @@ ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -76803,7 +75505,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -76819,7 +75521,7 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], "query": [ { @@ -76828,7 +75530,7 @@ "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -76841,14 +75543,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile?filter=&attributes=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76857,12 +75554,12 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" } ] }, { - "name": "Create a new Outdial ANI", + "name": "Create a new Multimedia Profile", "request": { "body": { "mode": "raw", @@ -76872,9 +75569,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, - "description": "Create a new Outdial ANI in a given organization.", + "description": "Create a new Multimedia Profile in a given organization.", "header": [ { "key": "Content-Type", @@ -76893,9 +75590,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76907,17 +75604,17 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -76927,7 +75624,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -76936,7 +75633,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -76947,9 +75644,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -76958,7 +75655,7 @@ ] } }, - "status": "Created" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -76981,7 +75678,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77001,9 +75698,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77015,17 +75712,17 @@ "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -77035,7 +75732,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77044,7 +75741,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -77055,9 +75752,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77066,12 +75763,12 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -77079,7 +75776,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -77089,7 +75786,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77109,9 +75806,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77120,12 +75817,12 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -77133,7 +75830,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -77143,7 +75840,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77163,9 +75860,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77174,7 +75871,7 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -77197,7 +75894,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77217,9 +75914,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77233,7 +75930,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -77241,7 +75938,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -77251,7 +75948,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -77271,9 +75968,9 @@ "path": [ "organization", ":orgid", - "outdial-ani" + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77282,12 +75979,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Bulk save Outdial ANI(s)", + "name": "Bulk save Multimedia Profile(s)", "request": { "body": { "mode": "raw", @@ -77297,9 +75994,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Outdial ANI(s) in bulk in a given organization.", + "description": "Create, Update or delete Multimedia Profile(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -77318,10 +76015,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77333,17 +76030,17 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -77353,7 +76050,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77362,7 +76059,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -77373,10 +76070,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77385,12 +76082,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 409, "cookie": [], "header": [ { @@ -77398,7 +76095,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -77408,7 +76105,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77428,10 +76125,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77440,20 +76137,20 @@ ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -77463,7 +76160,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77472,7 +76169,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -77483,10 +76180,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77495,12 +76192,12 @@ ] } }, - "status": "Bad Request" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -77508,7 +76205,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -77518,7 +76215,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77538,10 +76235,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77550,7 +76247,7 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -77573,7 +76270,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77593,10 +76290,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77628,7 +76325,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77648,10 +76345,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77665,7 +76362,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 400, "cookie": [], "header": [ { @@ -77673,7 +76370,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -77683,7 +76380,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"Kauo\\u000b\u2029K6\ufeff\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"bBcb9D2c2193-8bbffA17-ad7Bab75B1Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"d8CfF916-5FADc8f1-afDB7cafeE55f265\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"F\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"89A429C904A6da9Fa3f87e2a1e2ADD8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"4E2576Dd37A4-9F7ecbEB-5202FF9D7DFB\",\n \"id\": \"\",\n \"version\": \"\"\n }\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -77703,10 +76400,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77715,14 +76412,14 @@ ] } }, - "status": "Conflict" + "status": "Bad Request" } ] }, { - "name": "Bulk export Outdial ANI(s)", + "name": "Bulk export Multimedia Profile(s)", "request": { - "description": "Export all Outdial ANI(s) in a given organization.", + "description": "Export all Multimedia Profile(s) in a given organization.", "header": [ { "key": "Accept", @@ -77737,7 +76434,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -77749,10 +76446,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77766,7 +76463,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -77774,7 +76471,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -77790,7 +76487,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -77802,10 +76499,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77814,12 +76511,12 @@ ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -77827,7 +76524,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -77843,7 +76540,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -77855,10 +76552,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77867,7 +76564,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -77896,7 +76593,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -77908,10 +76605,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77924,7 +76621,7 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"entryDetails\": [\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n },\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"entryDetails\": [\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n },\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"telephony\": \"\",\n \"video\": \"\",\n \"social\": \"\",\n \"others\": \"\",\n \"active\": \"\",\n \"blendingModeEnabled\": \"\",\n \"blendingMode\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"dbEcf8b3-1e9A7A61-E11dDEAb87FD0EAC\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"fax\": \"\",\n \"telephony\": \"\",\n \"video\": \"\",\n \"social\": \"\",\n \"others\": \"\",\n \"active\": \"\",\n \"blendingModeEnabled\": \"\",\n \"blendingMode\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"5eB8aA3C-A5c0-C5884348-1F6795D22DDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -77949,7 +76646,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -77961,10 +76658,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -77978,7 +76675,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -77986,7 +76683,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -78002,7 +76699,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -78014,10 +76711,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78026,7 +76723,7 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -78055,7 +76752,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", "bulk-export" ], "query": [ @@ -78067,10 +76764,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78084,16 +76781,16 @@ ] }, { - "name": "List Outdial ANI Entry(s)", + "name": "Purge inactive Multimedia Profile(s)", "request": { - "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", + "description": "Purge inactive Multimedia Profile(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78101,37 +76798,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78161,7 +76838,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78169,37 +76846,65 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "multimedia-profile", + "purge-inactive-entities" + ], + "query": [ { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78208,12 +76913,12 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -78221,7 +76926,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -78229,7 +76934,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78237,37 +76942,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78276,28 +76961,28 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"name\": \"\u205fE-f\u205f\",\n \"number\": \"\",\n \"organizationId\": \"73DA6ccc0eDA2F2dB3FC561D569DbFf4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\nq\u2000s\",\n \"number\": \"\",\n \"organizationId\": \"7b05259E-AD98-eebf554FF73Fc6CB5cDb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Similar entity is already present", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78305,37 +76990,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78344,12 +77009,12 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -78357,7 +77022,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -78365,7 +77030,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78373,37 +77038,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78412,7 +77057,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -78433,7 +77078,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78441,37 +77086,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78485,7 +77110,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -78493,7 +77118,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -78501,7 +77126,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -78509,37 +77134,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", - "entry" + "multimedia-profile", + "purge-inactive-entities" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78548,14 +77153,14 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" } ] }, { - "name": "Get specific Outdial ANI by ID", + "name": "Get specific Multimedia Profile by ID", "request": { - "description": "Retrieve an existing Outdial ANI by ID in a given organization.", + "description": "Retrieve an existing Multimedia Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -78570,10 +77175,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78581,7 +77186,7 @@ "value": "" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id", "value": "" } @@ -78592,52 +77197,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -78645,7 +77205,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -78661,28 +77221,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -78690,7 +77250,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -78706,41 +77266,41 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -78751,23 +77311,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -78796,17 +77356,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] @@ -78815,22 +77375,22 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -78841,28 +77401,73 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "multimedia-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Multimedia Profile.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" } ] }, { - "name": "Update specific Outdial ANI by ID", + "name": "Update specific Multimedia Profile by ID", "request": { "body": { "mode": "raw", @@ -78872,9 +77477,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, - "description": "Update an existing Outdial ANI by ID in a given organization.", + "description": "Update an existing Multimedia Profile by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -78893,10 +77498,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -78904,7 +77509,7 @@ "value": "" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id", "value": "" } @@ -78915,7 +77520,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -78923,7 +77528,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -78933,7 +77538,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -78953,36 +77558,36 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"6MDy\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"eFDdA1A4DDdaAedDd522-96C1008ce3aE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"A2ccfa45E0aa4edf-D59B-44f6fF6aAfcD\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -78992,7 +77597,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79001,7 +77606,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "PUT", @@ -79012,28 +77617,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -79041,7 +77646,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -79051,7 +77656,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79071,28 +77676,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -79100,7 +77705,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -79110,7 +77715,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79130,28 +77735,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -79159,7 +77764,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -79169,7 +77774,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79189,28 +77794,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 412, "cookie": [], "header": [ { @@ -79218,7 +77823,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -79228,7 +77833,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79248,36 +77853,36 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -79287,7 +77892,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79296,7 +77901,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "PUT", @@ -79307,28 +77912,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 429, "cookie": [], "header": [ { @@ -79336,7 +77941,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -79346,7 +77951,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"\u00a0WnsH4\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C7eA8c8E-9Af40Ceb-D616-CE8f2ac8FEF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"fb8AAB353bD8b4e41FBd5BEB7030fE28\",\n \"id\": \"\",\n \"version\": \"\"\n }\n}" }, "header": [ { @@ -79366,30 +77971,30 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Too Many Requests" } ] }, { - "name": "Delete specific Outdial ANI by ID", + "name": "Delete specific Multimedia Profile by ID", "request": { - "description": "Delete an existing Outdial ANI by ID in a given organization.", + "description": "Delete an existing Multimedia Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -79404,10 +78009,10 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -79415,7 +78020,7 @@ "value": "" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id", "value": "" } @@ -79423,6 +78028,51 @@ } }, "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "multimedia-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Multimedia Profile.", + "key": "id" + } + ] + } + }, + "status": "Precondition Failed" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -79450,17 +78100,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] @@ -79495,17 +78145,17 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] @@ -79516,52 +78166,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -79569,7 +78174,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -79585,28 +78190,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -79614,7 +78219,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -79630,28 +78235,28 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -79659,7 +78264,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -79675,31 +78280,31 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 200, "cookie": [], "header": [], - "name": "No Content", + "name": "OK", "originalRequest": { "header": [], "method": "DELETE", @@ -79710,30 +78315,30 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI.", + "description": "Resource ID of the Multimedia Profile.", "key": "id" } ] } }, - "status": "No Content" + "status": "OK" } ] }, { - "name": "List references for a specific Outdial ANI", + "name": "List references for a specific Multimedia Profile", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -79748,7 +78353,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -79769,7 +78374,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -79788,7 +78393,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -79796,7 +78401,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -79812,7 +78417,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -79833,7 +78438,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -79846,7 +78451,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -79875,7 +78480,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -79896,7 +78501,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -79938,7 +78543,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -79959,7 +78564,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -79977,7 +78582,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -79985,7 +78590,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -80001,7 +78606,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -80022,7 +78627,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -80035,7 +78640,7 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -80064,7 +78669,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -80085,7 +78690,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -80127,7 +78732,7 @@ "path": [ "organization", ":orgid", - "outdial-ani", + "multimedia-profile", ":id", "incoming-references" ], @@ -80148,7 +78753,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -80166,30 +78771,16 @@ ] }, { - "name": "Create a new Outdial ANI Entry", + "name": "List Multimedia Profile(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, - "description": "Create a new Outdial ANI Entry in a given organization.", + "description": "Retrieve a list of Multimedia Profile(s) in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80197,20 +78788,41 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", "value": "" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -80220,7 +78832,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -80228,29 +78840,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80258,29 +78856,51 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 429, "cookie": [], "header": [ { @@ -80288,29 +78908,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80318,24 +78924,46 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -80350,27 +78978,13 @@ ], "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80378,19 +78992,41 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } @@ -80400,7 +79036,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -80408,29 +79044,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80438,89 +79060,51 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"k\u2007zP\u2004\\rc\u2001_w\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"C0d5c8bd-Fdd016DB-A7c7-1d97A384d14A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"3d8Ecd6fE5E5-a11E-624a-4c0c9F76b41A\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"blendingMode\": \"\",\n \"blendingModeEnabled\": \"\",\n \"chat\": \"\",\n \"email\": \"\",\n \"name\": \"g.\u202fe\u2004u\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"B4BEbcd072Bc8fec0Bed-F5dAccdAE60b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"manuallyAssignable\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"social\": \"\",\n \"telephony\": \"\",\n \"organizationId\": \"78ED7ce8-3bc5B4bA82ee-011cbB5AE4AA\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -80528,29 +79112,15 @@ "value": "*/*" } ], - "name": "Created", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80558,29 +79128,51 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Created" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -80588,29 +79180,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80618,52 +79196,65 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry" + "v2", + "multimedia-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" } ] - }, + } + ], + "name": "Multimedia Profile" + }, + { + "item": [ { - "name": "Bulk save Outdial ANI Entry(s)", + "name": "List Outdial ANI(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Outdial ANI Entry(s) in bulk for an Address Book in a given organization.", + "description": "Retrieve a list of Outdial ANI(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80671,21 +79262,40 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", "value": "" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -80695,7 +79305,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -80703,29 +79313,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80733,25 +79329,45 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -80766,27 +79382,13 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80794,20 +79396,40 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } @@ -80827,27 +79449,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80855,20 +79463,40 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } @@ -80888,27 +79516,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80916,20 +79530,40 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } @@ -80938,8 +79572,8 @@ }, { "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "body": "[\n {\n \"organizationId\": \"D4bfFA42D0cD-Bf2b-E0c5-5C104FAe6fD2\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"2-\\norxZ1\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"39Ce6B414cc9F0537a84af7e39C0Cd36\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\u2005\u2029\u2000\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -80947,29 +79581,15 @@ "value": "*/*" } ], - "name": "Multi-Status", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -80977,30 +79597,50 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -81008,29 +79648,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -81038,38 +79664,105 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Bad Request" + "status": "Not Found" + } + ] + }, + { + "name": "Create a new Outdial ANI", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "description": "Create a new Outdial ANI in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "outdial-ani" + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -81079,7 +79772,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -81088,7 +79781,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -81099,76 +79792,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - "bulk" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" } ] } }, - "status": "Forbidden" - } - ] - }, - { - "name": "Get specific Outdial ANI Entry by ID", - "request": { - "description": "Retrieve an existing Outdial ANI Entry by ID in a given organization.", - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", - "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ + "status": "Created" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -81176,15 +79816,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81192,34 +79846,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -81227,15 +79870,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81243,34 +79900,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -81278,15 +79924,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81294,34 +79954,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -81329,15 +79978,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81345,34 +80008,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -81380,15 +80032,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81396,50 +80062,53 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81447,34 +80116,23 @@ "path": [ "organization", ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "outdial-ani" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" } ] }, { - "name": "Update specific Outdial ANI Entry by ID", + "name": "Bulk save Outdial ANI(s)", "request": { "body": { "mode": "raw", @@ -81484,9 +80142,9 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Update an existing Outdial ANI Entry by ID in a given organization.", + "description": "Create, Update or delete Outdial ANI(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -81497,7 +80155,7 @@ "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81506,43 +80164,31 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", - "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -81552,7 +80198,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81561,10 +80207,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81573,33 +80219,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -81607,7 +80243,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -81617,7 +80253,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81629,7 +80265,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81638,33 +80274,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 400, "cookie": [], "header": [ { @@ -81672,7 +80298,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -81682,7 +80308,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81694,7 +80320,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81703,33 +80329,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 403, "cookie": [], "header": [ { @@ -81737,7 +80353,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -81747,7 +80363,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81759,72 +80375,7 @@ "value": "application/json" } ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" - } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81833,33 +80384,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -81867,7 +80408,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -81877,7 +80418,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81889,7 +80430,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81898,33 +80439,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -81932,7 +80463,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -81942,7 +80473,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -81954,7 +80485,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -81963,33 +80494,23 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -81997,7 +80518,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -82007,7 +80528,7 @@ "language": "json" } }, - "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u200a\ufeff.\u2000w7X3O\",\n \"organizationId\": \"B439278B-3ae7e0fDD8Fb-faF40befBEDB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2002\",\n \"number\": \"\",\n \"organizationId\": \"d13E587d-f212723B9557DACFeB02303c\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2029\\tv\",\n \"number\": \"\",\n \"organizationId\": \"15f4BB9B-0AA1-6Df4e33ceaae9Ca1673E\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u20070S\",\n \"organizationId\": \"aEE0657BEc0E-9CeB-fcB1c38Fc41FDFde\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"V\",\n \"number\": \"\",\n \"organizationId\": \"561075f2acf022F2-41AF3b274cCea2b5\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\u2006ijl\",\n \"number\": \"\",\n \"organizationId\": \"caC3A5c63B8a-9c96-A2baf4aBF449eA1D\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -82019,7 +80540,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -82028,42 +80549,32 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Bad Request" + "status": "Conflict" } ] }, { - "name": "Delete specific Outdial ANI Entry by ID", + "name": "Bulk export Outdial ANI(s)", "request": { - "description": "Delete an existing Outdial ANI Entry by ID in a given organization.", + "description": "Export all Outdial ANI(s) in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82072,25 +80583,25 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", - "value": "" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id", + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", "value": "" } ] @@ -82100,7 +80611,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -82108,7 +80619,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -82116,7 +80627,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82125,33 +80636,35 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -82159,7 +80672,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -82167,7 +80680,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82176,33 +80689,35 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -82210,7 +80725,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -82218,7 +80733,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82227,49 +80742,51 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"entryDetails\": [\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n },\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"entryDetails\": [\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n },\n {\n \"entryName\": \"\",\n \"entryNumber\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82278,64 +80795,25 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, + "query": [ { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, - "cookie": [], - "header": [], - "name": "OK", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "outdial-ani", - ":outDialAniId", - "entry", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } @@ -82345,7 +80823,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 401, "cookie": [], "header": [ { @@ -82353,7 +80831,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -82361,7 +80839,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82370,33 +80848,35 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -82404,7 +80884,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -82412,7 +80892,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -82421,35 +80901,37 @@ "organization", ":orgid", "outdial-ani", - ":outDialAniId", - "entry", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" - }, + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export?page=0&pageSize=50", + "variable": [ { - "description": "ID of this contact center resource.", - "key": "id" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Forbidden" } ] }, { - "name": "List Outdial ANI(s)", + "name": "List Outdial ANI Entry(s)", "request": { - "description": "Retrieve a list of Outdial ANI(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", "header": [ { "key": "Accept", @@ -82464,22 +80946,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82492,14 +80974,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82511,22 +80988,22 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"name\": \"\\fjeJs\u2006\",\n \"organizationId\": \"30CFE2FA-6bDe7bB1-65a5-c5BbDe9E8deF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2007a_aMv1\u202f\u2000H\",\n \"number\": \"\",\n \"organizationId\": \"8dAe9efBA636a0bCF6Eb-Efe7bf6a82c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \" EAb\",\n \"number\": \"\",\n \"organizationId\": \"aB96eDA00AC64EABDcE9-e65Cb8d0EbEd\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"N\",\n \"organizationId\": \"E8ad630D-85ED-e8DB-Ec8E94E4C2a1cD65\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"l\u200akAT\ufeff\\t\",\n \"number\": \"\",\n \"organizationId\": \"9e0a4cEb4A3F-a5Db-44Ff-E692Ca78424b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"LG\",\n \"number\": \"\",\n \"organizationId\": \"B1C26002CFF1F24Bf67FCD9cbB07fBbe\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -82537,22 +81014,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82565,14 +81042,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82581,12 +81053,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -82594,7 +81066,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -82610,22 +81082,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82638,14 +81110,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82654,25 +81121,25 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 8788.506134327154,\n \"key_2\": \"string\",\n \"key_3\": 8257.21105049366\n },\n \"data\": [\n {\n \"name\": \"\u205fE-f\u205f\",\n \"number\": \"\",\n \"organizationId\": \"73DA6ccc0eDA2F2dB3FC561D569DbFf4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\nq\u2000s\",\n \"number\": \"\",\n \"organizationId\": \"7b05259E-AD98-eebf554FF73Fc6CB5cDb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -82683,22 +81150,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82711,14 +81178,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82727,12 +81189,12 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -82740,7 +81202,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -82756,22 +81218,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82784,14 +81246,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82800,12 +81257,12 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -82813,7 +81270,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -82829,22 +81286,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82857,14 +81314,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82873,12 +81325,12 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -82886,7 +81338,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -82902,22 +81354,22 @@ "path": [ "organization", ":orgid", - "v2", - "outdial-ani" + "outdial-ani", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except outdialANIEntries", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -82930,14 +81382,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -82946,14 +81393,14 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "List Outdial ANI Entry(s)", + "name": "Get specific Outdial ANI by ID", "request": { - "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", + "description": "Retrieve an existing Outdial ANI by ID in a given organization.", "header": [ { "key": "Accept", @@ -82968,39 +81415,10 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -83008,8 +81426,8 @@ "value": "" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId", + "description": "Resource ID of the Outdial ANI.", + "key": "id", "value": "" } ] @@ -83019,7 +81437,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -83027,7 +81445,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -83043,70 +81461,41 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"data\": [\n {\n \"name\": \"\u205fE-f\u205f\",\n \"number\": \"\",\n \"organizationId\": \"73DA6ccc0eDA2F2dB3FC561D569DbFf4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\nq\u2000s\",\n \"number\": \"\",\n \"organizationId\": \"7b05259E-AD98-eebf554FF73Fc6CB5cDb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -83117,57 +81506,28 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -83175,7 +81535,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -83191,57 +81551,28 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -83249,7 +81580,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -83265,57 +81596,28 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -83323,7 +81625,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -83339,70 +81641,41 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -83413,71 +81686,51 @@ "path": [ "organization", ":orgid", - "v2", "outdial-ani", - ":outDialAniId", - "entry" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Outdial ANI", - "key": "outDialAniId" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" } ] - } - ], - "name": "Outdial ANI" - }, - { - "item": [ + }, { - "name": "List Site(s)", + "name": "Update specific Outdial ANI by ID", "request": { - "description": "Retrieve a list of Site(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Update an existing Outdial ANI by ID in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -83485,26 +81738,20 @@ "path": [ "organization", ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id", + "value": "" } ] } @@ -83513,7 +81760,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -83521,119 +81768,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", - "originalRequest": { + }, + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -83641,234 +81798,24 @@ "path": [ "organization", ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, "status": "Too Many Requests" }, - { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"Id1B\u2028\\n1vC8f\",\n \"organizationId\": \"5bcD35F6e794797D-eB9b-82D7BeFc601a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"mjiBh2p8\",\n \"organizationId\": \"a8Ef59E0-3C4F6677-18bE-2F6b1AAb79A3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "query": [ - { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Create a new Site", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Create a new Site in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site" - ], - "raw": "{{baseUrl}}/organization/:orgid/site", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -83890,7 +81837,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -83902,7 +81849,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -83910,13 +81857,18 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } @@ -83944,7 +81896,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -83956,7 +81908,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -83964,13 +81916,18 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } @@ -83998,7 +81955,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -84010,7 +81967,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -84018,13 +81975,18 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } @@ -84034,7 +81996,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -84042,7 +82004,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -84052,7 +82014,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -84064,7 +82026,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -84072,23 +82034,28 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -84096,7 +82063,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -84106,7 +82073,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -84118,7 +82085,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -84126,23 +82093,28 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "body": "{\n \"name\": \"\",\n \"organizationId\": \"D5A698Cd-0dEDD25e-EaB3fc98e9F5464c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2028R\u2001J\u202f\u2028\\u000bP\ufefft\",\n \"number\": \"\",\n \"organizationId\": \"C6accF9B-E07cd1aC83ec-6ed5Fc8eB21c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"Zw\u00a0I\u30009\",\n \"number\": \"\",\n \"organizationId\": \"eaB0f45a-9adF-dDC7BebD97Ef8aF2DaC2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -84150,7 +82122,7 @@ "value": "*/*" } ], - "name": "Created", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -84160,7 +82132,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -84172,7 +82144,7 @@ "value": "*/*" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -84180,23 +82152,28 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Created" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -84204,7 +82181,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -84214,7 +82191,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"ug2o\u2006\",\n \"organizationId\": \"bCf93ac8e26A-13B5-05e36386bA5ce9fa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"5 U\u202f\u2005\u2029w\",\n \"number\": \"\",\n \"organizationId\": \"1DD2A0df-0ff29bfb782fb5faBfa13f70\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\",\n \"organizationId\": \"3fd45e1e05E9dAEe022b-7A7bFAdD27aF\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -84226,7 +82203,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -84234,46 +82211,37 @@ "path": [ "organization", ":orgid", - "site" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" } ] }, { - "name": "Bulk save Site(s)", + "name": "Delete specific Outdial ANI by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Site(s) in bulk in a given organization.", + "description": "Delete an existing Outdial ANI by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84281,54 +82249,45 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84336,24 +82295,28 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -84361,29 +82324,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84391,24 +82340,28 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -84416,29 +82369,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84446,24 +82385,28 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -84471,29 +82414,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84501,24 +82430,28 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 412, "cookie": [], "header": [ { @@ -84526,29 +82459,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84556,19 +82475,23 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", @@ -84583,27 +82506,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84611,14 +82520,18 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } @@ -84626,39 +82539,15 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Similar entity is already present", + "header": [], + "name": "No Content", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -84666,26 +82555,30 @@ "path": [ "organization", ":orgid", - "site", - "bulk" + "outdial-ani", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "No Content" } ] }, { - "name": "Bulk export Site(s)", + "name": "List references for a specific Outdial ANI", "request": { - "description": "Export all Site(s) in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization.", "header": [ { "key": "Accept", @@ -84700,10 +82593,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84715,12 +82614,17 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } @@ -84729,7 +82633,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -84737,7 +82641,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -84753,10 +82657,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84768,21 +82678,25 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -84790,7 +82704,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -84806,10 +82720,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84821,21 +82741,25 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -84843,7 +82767,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -84859,10 +82783,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84874,34 +82804,38 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"multimediaProfileName\": \"\"\n },\n {\n \"name\": \"\",\n \"multimediaProfileName\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -84912,10 +82846,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84927,21 +82867,25 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -84949,7 +82893,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -84965,10 +82909,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -84980,34 +82930,38 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -85018,10 +82972,16 @@ "path": [ "organization", ":orgid", - "site", - "bulk-export" + "outdial-ani", + ":id", + "incoming-references" ], "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -85033,24 +82993,42 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" } ] }, { - "name": "Purge inactive Site(s)", + "name": "Create a new Outdial ANI Entry", "request": { - "description": "Purge inactive Site(s) older than the configured interval for a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Create a new Outdial ANI Entry in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" @@ -85064,44 +83042,57 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -85112,31 +83103,29 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -85144,9 +83133,23 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -85160,31 +83163,29 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -85192,9 +83193,23 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -85208,31 +83223,29 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -85240,9 +83253,23 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -85256,31 +83283,29 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 500, "cookie": [], "header": [ { @@ -85288,9 +83313,23 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -85304,44 +83343,56 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "Created", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], "method": "POST", @@ -85352,31 +83403,29 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Unauthorized" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -85384,9 +83433,23 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -85400,40 +83463,52 @@ "path": [ "organization", ":orgid", - "site", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "outdial-ani", + ":outDialAniId", + "entry" ], - "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" } ] }, { - "name": "Get specific Site by ID", + "name": "Bulk save Outdial ANI Entry(s)", "request": { - "description": "Retrieve an existing Site by ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Outdial ANI Entry(s) in bulk for an Address Book in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85441,10 +83516,12 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -85452,8 +83529,8 @@ "value": "" }, { - "description": "Resource ID of the Site.", - "key": "id", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", "value": "" } ] @@ -85463,7 +83540,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -85471,15 +83548,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85487,23 +83578,25 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -85518,13 +83611,27 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85532,18 +83639,20 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } @@ -85553,7 +83662,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -85561,15 +83670,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85577,23 +83700,25 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -85608,13 +83733,27 @@ ], "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85622,28 +83761,91 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, "status": "Unauthorized" }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Multi-Status", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + } + ] + } + }, + "status": "Multi-Status (WebDAV) (RFC 4918)" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -85651,15 +83853,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85667,44 +83883,60 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"\u180ej\\tMI\u2029I5uE\",\n \"number\": \"\",\n \"organizationId\": \"6B499F66D6a5-599E-cE8F-F288C0b1Eaf0\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"name\": \"sCFhK\",\n \"number\": \"\",\n \"organizationId\": \"0EEfef5F-371dd94C-aBe1-3bE78fC6FB17\",\n \"id\": \"\",\n \"version\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -85712,51 +83944,39 @@ "path": [ "organization", ":orgid", - "site", - ":id" + "outdial-ani", + ":outDialAniId", + "entry", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "OK" + "status": "Forbidden" } ] }, { - "name": "Update specific Site by ID", + "name": "Get specific Outdial ANI Entry by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "description": "Update an existing Site by ID in a given organization.", + "description": "Retrieve an existing Outdial ANI Entry by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85764,10 +83984,12 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -85775,7 +83997,12 @@ "value": "" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", + "value": "" + }, + { + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -85786,7 +84013,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 500, "cookie": [], "header": [ { @@ -85794,29 +84021,15 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85824,28 +84037,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -85853,29 +84072,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85883,28 +84088,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -85912,29 +84123,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -85942,58 +84139,50 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86001,23 +84190,29 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -86032,27 +84227,13 @@ ], "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86060,17 +84241,23 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] @@ -86079,39 +84266,25 @@ "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -86119,24 +84292,90 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Not Found" + "status": "OK" + } + ] + }, + { + "name": "Update specific Outdial ANI Entry by ID", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, + "description": "Update an existing Outdial ANI Entry by ID in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "outdial-ani", + ":outDialAniId", + "entry", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -86158,7 +84397,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -86178,17 +84417,23 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] @@ -86199,7 +84444,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -86207,7 +84452,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -86217,7 +84462,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -86237,67 +84482,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Bad Request" - } - ] - }, - { - "name": "Delete specific Site by ID", - "request": { - "description": "Delete an existing Site by ID in a given organization.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Site.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ + "status": "Unauthorized" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -86305,15 +84517,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86321,58 +84547,29 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, - "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "site", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" }, { - "description": "Resource ID of the Site.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "No Content" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -86387,13 +84584,27 @@ ], "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86401,17 +84612,23 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] @@ -86420,25 +84637,39 @@ "status": "Precondition Failed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"name\": \"D\\u000b3\",\n \"number\": \"\",\n \"organizationId\": \"Dcbc63e6A2af73ee135A-aF2F2cC3de9b\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86446,28 +84677,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -86475,15 +84712,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86491,28 +84742,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -86520,15 +84777,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86536,28 +84807,34 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -86565,15 +84842,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"zE\",\n \"number\": \"\",\n \"organizationId\": \"c44C6Fb73c24-1147-eDB7-CE9BAe5DE2cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"defaultANIEntry\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -86581,37 +84872,43 @@ "path": [ "organization", ":orgid", - "site", + "outdial-ani", + ":outDialAniId", + "entry", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Site.", + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, + { + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" } ] }, { - "name": "List references for a specific Site", + "name": "Delete specific Outdial ANI Entry by ID", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Site by ID in a given organization.", + "description": "Delete an existing Outdial ANI Entry by ID in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86619,34 +84916,23 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", + "value": "" + }, { "description": "ID of this contact center resource.", "key": "id", @@ -86659,7 +84945,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -86667,7 +84953,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -86675,7 +84961,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86683,33 +84969,21 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -86717,12 +84991,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -86730,7 +85004,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -86738,7 +85012,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86746,33 +85020,21 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -86780,12 +85042,12 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -86793,7 +85055,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -86801,7 +85063,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86809,33 +85071,21 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -86843,12 +85093,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -86856,7 +85106,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -86864,7 +85114,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86872,33 +85122,62 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", + "variable": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "ID of this contact center resource.", + "key": "id" } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "OK", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "outdial-ani", + ":outDialAniId", + "entry", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -86906,12 +85185,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 412, "cookie": [], "header": [ { @@ -86919,7 +85198,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -86927,7 +85206,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86935,33 +85214,21 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -86969,28 +85236,28 @@ ] } }, - "status": "Unauthorized" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -86998,33 +85265,21 @@ "path": [ "organization", ":orgid", - "site", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "outdial-ani", + ":outDialAniId", + "entry", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" + }, { "description": "ID of this contact center resource.", "key": "id" @@ -87032,14 +85287,14 @@ ] } }, - "status": "OK" + "status": "Not Found" } ] }, { - "name": "List Site(s)", + "name": "List Outdial ANI(s)", "request": { - "description": "Retrieve a list of Site(s) in a given organization.", + "description": "Retrieve a list of Outdial ANI(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", @@ -87055,21 +85310,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87082,9 +85337,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87096,22 +85356,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"name\": \"\\fjeJs\u2006\",\n \"organizationId\": \"30CFE2FA-6bDe7bB1-65a5-c5BbDe9E8deF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"\u2007a_aMv1\u202f\u2000H\",\n \"number\": \"\",\n \"organizationId\": \"8dAe9efBA636a0bCF6Eb-Efe7bf6a82c9\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \" EAb\",\n \"number\": \"\",\n \"organizationId\": \"aB96eDA00AC64EABDcE9-e65Cb8d0EbEd\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"N\",\n \"organizationId\": \"E8ad630D-85ED-e8DB-Ec8E94E4C2a1cD65\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"outdialANIEntries\": [\n {\n \"name\": \"l\u200akAT\ufeff\\t\",\n \"number\": \"\",\n \"organizationId\": \"9e0a4cEb4A3F-a5Db-44Ff-E692Ca78424b\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"LG\",\n \"number\": \"\",\n \"organizationId\": \"B1C26002CFF1F24Bf67FCD9cbB07fBbe\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -87123,21 +85383,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87150,9 +85410,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87161,25 +85426,25 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"wp\u180eoo\",\n \"organizationId\": \"6e6FFaCEEB5dFAff-31A0dEF126CA7331\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"uG\\r\u180ea\u202fy\",\n \"organizationId\": \"D5E60f6c-9eEF172Edbc635ce9E1C1CFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -87191,21 +85456,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87218,9 +85483,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87229,12 +85499,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -87242,7 +85512,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -87259,21 +85529,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87286,9 +85556,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87297,7 +85572,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -87327,21 +85602,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87354,9 +85629,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87370,7 +85650,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -87378,7 +85658,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -87395,21 +85675,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87422,9 +85702,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87433,12 +85718,12 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -87446,7 +85731,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -87463,21 +85748,21 @@ "organization", ":orgid", "v2", - "site" + "outdial-ani" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, outdialANIEntries, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -87490,9 +85775,14 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87501,19 +85791,14 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" } ] - } - ], - "name": "Site" - }, - { - "item": [ + }, { - "name": "List Skill(s)", + "name": "List Outdial ANI Entry(s)", "request": { - "description": "Retrieve a list of Skill(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Outdial ANI Entry(s) in a given organization.", "header": [ { "key": "Accept", @@ -87528,19 +85813,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87550,19 +85843,19 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId", + "value": "" } ] } @@ -87595,19 +85888,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87617,18 +85918,17 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } @@ -87636,22 +85936,22 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": 8788.506134327154,\n \"key_2\": \"string\",\n \"key_3\": 8257.21105049366\n },\n \"data\": [\n {\n \"name\": \"\u205fE-f\u205f\",\n \"number\": \"\",\n \"organizationId\": \"73DA6ccc0eDA2F2dB3FC561D569DbFf4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\\nq\u2000s\",\n \"number\": \"\",\n \"organizationId\": \"7b05259E-AD98-eebf554FF73Fc6CB5cDb\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -87662,19 +85962,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87684,28 +85992,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -87713,7 +86020,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -87729,19 +86036,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87751,28 +86066,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -87780,7 +86094,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -87796,19 +86110,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87818,28 +86140,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -87847,7 +86168,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -87863,63 +86184,70 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"active\": \"\",\n \"name\": \"kRAT\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Boolean\",\n \"organizationId\": \"89D6715dcF303afe2bE6-2f2C7EDF5c8e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"fXUV4\\nYD\",\n \"organizationId\": \"B8e6c0b4-9DAFee50-E98a1176C13Baede\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"5\u2004\u2001wGAo32U\",\n \"organizationId\": \"3A389Fc9-c6cD-f91DE22A-43F4A5A94aD7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"11bCa2303F1b-3f1074cBc44B7DbE9aDa\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"PY\u205f\",\n \"organizationId\": \"A57c7A3C-f2Bc-768A-D71C5dCA46b36De8\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"h\u2029El\u30005\u200aZ\u2001\",\n \"organizationId\": \"4b5E61b0-f1fc-4B03-7feb2dF52D68eF6a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -87930,19 +86258,27 @@ "path": [ "organization", ":orgid", - "skill" + "v2", + "outdial-ani", + ":outDialAniId", + "entry" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -87952,14 +86288,323 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "description": "Resource ID of the Outdial ANI", + "key": "outDialAniId" } + ] + } + }, + "status": "Internal Server Error" + } + ] + } + ], + "name": "Outdial ANI" + }, + { + "item": [ + { + "name": "List Site(s)", + "request": { + "description": "Retrieve a list of Site(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": "[\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2028O\\n2S3\",\n \"organizationId\": \"A92FbaD9-BC2E38b0ED5c-ACf17382AeBb\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"q0i\u2009fl2\\u000bT\",\n \"organizationId\": \"CfCf4Ade8177e0A1-af20-C3b09B753C84\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -87969,11 +86614,63 @@ } }, "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site?filter=&attributes=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" } ] }, { - "name": "Create a new Skill", + "name": "Create a new Site", "request": { "body": { "mode": "raw", @@ -87983,9 +86680,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, - "description": "Create a new Skill in a given organization.", + "description": "Create a new Site in a given organization.", "header": [ { "key": "Content-Type", @@ -88004,9 +86701,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88018,17 +86715,17 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -88038,7 +86735,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88047,7 +86744,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -88058,9 +86755,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88069,12 +86766,12 @@ ] } }, - "status": "Created" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -88082,7 +86779,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -88092,7 +86789,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88112,9 +86809,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88123,12 +86820,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -88136,7 +86833,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -88146,7 +86843,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88166,9 +86863,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88177,12 +86874,12 @@ ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 409, "cookie": [], "header": [ { @@ -88190,7 +86887,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -88200,7 +86897,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88220,9 +86917,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88231,12 +86928,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -88244,7 +86941,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -88254,7 +86951,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88274,9 +86971,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88285,20 +86982,20 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -88308,7 +87005,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88317,7 +87014,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -88328,9 +87025,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88339,12 +87036,12 @@ ] } }, - "status": "Bad Request" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -88352,7 +87049,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -88362,7 +87059,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -88382,9 +87079,9 @@ "path": [ "organization", ":orgid", - "skill" + "site" ], - "raw": "{{baseUrl}}/organization/:orgid/skill", + "raw": "{{baseUrl}}/organization/:orgid/site", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88393,12 +87090,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] }, { - "name": "Bulk save Skill(s)", + "name": "Bulk save Site(s)", "request": { "body": { "mode": "raw", @@ -88408,9 +87105,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Skill(s) in bulk in a given organization.", + "description": "Create, Update or delete Site(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -88429,10 +87126,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88444,17 +87141,17 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -88464,7 +87161,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88473,7 +87170,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -88484,10 +87181,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88496,20 +87193,20 @@ ] } }, - "status": "Bad Request" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -88519,7 +87216,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88528,7 +87225,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -88539,10 +87236,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88551,12 +87248,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -88564,7 +87261,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -88574,7 +87271,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88594,10 +87291,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88606,12 +87303,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -88619,7 +87316,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -88629,7 +87326,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88649,10 +87346,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88661,12 +87358,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 400, "cookie": [], "header": [ { @@ -88674,7 +87371,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -88684,7 +87381,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88704,10 +87401,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88716,7 +87413,7 @@ ] } }, - "status": "Conflict" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -88739,7 +87436,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88759,10 +87456,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88776,7 +87473,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 409, "cookie": [], "header": [ { @@ -88784,7 +87481,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -88794,7 +87491,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"v\",\n \"organizationId\": \"c6ad25fbccf24C9ca6c8-ff8EFD3E73F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \" ab2\",\n \"organizationId\": \"629579a45EDafA154C4F-44413a72Ae7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -88814,10 +87511,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88826,14 +87523,14 @@ ] } }, - "status": "Forbidden" + "status": "Conflict" } ] }, { - "name": "Bulk export Skill(s)", + "name": "Bulk export Site(s)", "request": { - "description": "Export all Skill(s) in a given organization.", + "description": "Export all Site(s) in a given organization.", "header": [ { "key": "Accept", @@ -88848,7 +87545,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -88860,10 +87557,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88877,7 +87574,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -88885,7 +87582,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -88901,7 +87598,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -88913,10 +87610,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88925,25 +87622,25 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -88954,7 +87651,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -88966,10 +87663,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -88978,7 +87675,7 @@ ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -89007,7 +87704,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -89019,10 +87716,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89034,22 +87731,22 @@ "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"multimediaProfileName\": \"\"\n },\n {\n \"name\": \"\",\n \"multimediaProfileName\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -89060,7 +87757,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -89072,10 +87769,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89084,12 +87781,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -89097,7 +87794,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -89113,7 +87810,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -89125,10 +87822,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89137,12 +87834,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -89150,7 +87847,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -89166,7 +87863,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "bulk-export" ], "query": [ @@ -89178,10 +87875,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "50" + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/site/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89190,14 +87887,14 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" } ] }, { - "name": "Purge inactive Skill(s)", + "name": "Purge inactive Site(s)", "request": { - "description": "Purge inactive Skill(s) older than the configured interval for a given organization.", + "description": "Purge inactive Site(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -89212,7 +87909,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89222,7 +87919,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89234,22 +87931,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -89260,7 +87957,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89270,7 +87967,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89279,12 +87976,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 500, "cookie": [], "header": [ { @@ -89292,7 +87989,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -89308,7 +88005,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89318,7 +88015,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89327,12 +88024,12 @@ ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 409, "cookie": [], "header": [ { @@ -89340,7 +88037,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Similar entity is already present", "originalRequest": { "header": [ { @@ -89356,7 +88053,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89366,7 +88063,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89375,7 +88072,7 @@ ] } }, - "status": "Forbidden" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -89404,7 +88101,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89414,7 +88111,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89428,7 +88125,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -89436,7 +88133,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -89452,7 +88149,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89462,7 +88159,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89471,25 +88168,25 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -89500,7 +88197,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89510,7 +88207,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89519,12 +88216,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -89532,7 +88229,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -89548,7 +88245,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", "purge-inactive-entities" ], "query": [ @@ -89558,7 +88255,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89567,14 +88264,14 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" } ] }, { - "name": "Get specific Skill by ID", + "name": "Get specific Site by ID", "request": { - "description": "Retrieve an existing Skill by ID in a given organization.", + "description": "Retrieve an existing Site by ID in a given organization.", "header": [ { "key": "Accept", @@ -89589,10 +88286,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89600,7 +88297,7 @@ "value": "" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id", "value": "" } @@ -89611,7 +88308,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -89619,7 +88316,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -89635,28 +88332,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -89664,7 +88361,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -89680,28 +88377,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -89709,7 +88406,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -89725,41 +88422,41 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -89770,28 +88467,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -89799,7 +88496,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -89815,41 +88512,41 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -89860,28 +88557,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" } ] }, { - "name": "Update specific Skill by ID", + "name": "Update specific Site by ID", "request": { "body": { "mode": "raw", @@ -89891,9 +88588,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, - "description": "Update an existing Skill by ID in a given organization.", + "description": "Update an existing Site by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -89912,10 +88609,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -89923,7 +88620,7 @@ "value": "" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id", "value": "" } @@ -89932,17 +88629,17 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -89952,7 +88649,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -89961,7 +88658,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "PUT", @@ -89972,28 +88669,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "OK" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 429, "cookie": [], "header": [ { @@ -90001,7 +88698,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -90011,7 +88708,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90031,28 +88728,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -90060,7 +88757,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -90070,7 +88767,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90090,28 +88787,87 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\ufeffPD\u2028LXg\",\n \"organizationId\": \"Bcb3fA70-fE58-6a6Cbfa5-ce76CD23a8Ad\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/site/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Site.", + "key": "id" + } + ] + } + }, + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -90119,7 +88875,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -90129,7 +88885,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90149,23 +88905,23 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -90188,7 +88944,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90208,17 +88964,17 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] @@ -90229,66 +88985,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "skill", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the Skill.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -90296,7 +88993,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -90306,7 +89003,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90326,28 +89023,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -90355,7 +89052,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -90365,7 +89062,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"\u2004tZb\u2008F\",\n \"organizationId\": \"a4Df0daC-A72f2c3A5DE9-A16fdAb5456E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" }, "header": [ { @@ -90385,30 +89082,30 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] }, { - "name": "Delete specific Skill by ID", + "name": "Delete specific Site by ID", "request": { - "description": "Delete an existing Skill by ID in a given organization.", + "description": "Delete an existing Site by ID in a given organization.", "header": [ { "key": "Accept", @@ -90423,10 +89120,10 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -90434,7 +89131,7 @@ "value": "" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id", "value": "" } @@ -90445,7 +89142,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -90453,7 +89150,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -90469,43 +89166,33 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "header": [], + "name": "No Content", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -90514,28 +89201,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "No Content" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -90543,7 +89230,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -90559,23 +89246,23 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", @@ -90604,17 +89291,17 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] @@ -90625,7 +89312,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -90633,7 +89320,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -90649,28 +89336,28 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -90678,7 +89365,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -90694,33 +89381,43 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ @@ -90729,30 +89426,30 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "raw": "{{baseUrl}}/organization/:orgid/site/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill.", + "description": "Resource ID of the Site.", "key": "id" } ] } }, - "status": "No Content" + "status": "Internal Server Error" } ] }, { - "name": "List references for a specific Skill", + "name": "List references for a specific Site", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Skill by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Site by ID in a given organization.", "header": [ { "key": "Accept", @@ -90767,7 +89464,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id", "incoming-references" ], @@ -90788,7 +89485,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -90805,22 +89502,22 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -90831,7 +89528,70 @@ "path": [ "organization", ":orgid", - "skill", + "site", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "site", ":id", "incoming-references" ], @@ -90852,7 +89612,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -90865,7 +89625,7 @@ ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -90894,7 +89654,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id", "incoming-references" ], @@ -90915,7 +89675,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -90933,70 +89693,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "skill", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -91004,7 +89701,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -91020,7 +89717,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id", "incoming-references" ], @@ -91041,7 +89738,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91054,12 +89751,12 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -91067,7 +89764,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -91083,7 +89780,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id", "incoming-references" ], @@ -91104,7 +89801,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91117,25 +89814,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -91146,7 +89843,7 @@ "path": [ "organization", ":orgid", - "skill", + "site", ":id", "incoming-references" ], @@ -91167,7 +89864,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91180,14 +89877,14 @@ ] } }, - "status": "Forbidden" + "status": "OK" } ] }, { - "name": "List Skill(s)", + "name": "List Site(s)", "request": { - "description": "Retrieve a list of Skill(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Site(s) in a given organization.", "header": [ { "key": "Accept", @@ -91203,16 +89900,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91230,14 +89927,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91251,7 +89943,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -91259,7 +89951,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -91276,16 +89968,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91303,14 +89995,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91319,25 +90006,25 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"wp\u180eoo\",\n \"organizationId\": \"6e6FFaCEEB5dFAff-31A0dEF126CA7331\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"multimediaProfileId\": \"\",\n \"name\": \"uG\\r\u180ea\u202fy\",\n \"organizationId\": \"D5E60f6c-9eEF172Edbc635ce9E1C1CFE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -91349,16 +90036,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91376,14 +90063,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91392,12 +90074,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -91405,7 +90087,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -91422,16 +90104,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91449,14 +90131,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91465,12 +90142,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -91478,7 +90155,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -91495,16 +90172,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91522,14 +90199,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91538,12 +90210,12 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -91551,7 +90223,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -91568,16 +90240,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91595,14 +90267,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91611,25 +90278,25 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"\u2028Xu\u2002PZT\u2002\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"80F9a2AEFEeBBddA-aeB0e27c14eFE032\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"lxz\",\n \"organizationId\": \"AbA9f0F48C821e9252D7e5c90DA3bDF0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"paw\ufeffA\",\n \"organizationId\": \"28c20b66-CfE1BbEB-124c-04fa02F8deDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"2A.\ufeff\u202frKy\u2005V\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"b0fEc6a3-f3575B61-2e734FcB02cF768f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \".\\nP\",\n \"organizationId\": \"C3a2D0AA6Bb6-3AB9E75b6979882CDc0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2029s\",\n \"organizationId\": \"DAaD8e4d8Af4-eeEcdbae-099BC8ED788a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -91641,16 +90308,16 @@ "organization", ":orgid", "v2", - "skill" + "site" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (enumSkillValues)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", "key": "attributes", "value": "" }, @@ -91668,14 +90335,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/site?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91684,19 +90346,19 @@ ] } }, - "status": "OK" + "status": "Too Many Requests" } ] } ], - "name": "Skill" + "name": "Site" }, { "item": [ { - "name": "List Skill Profile(s)", + "name": "List Skill(s)", "request": { - "description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Skill(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.", "header": [ { "key": "Accept", @@ -91711,16 +90373,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -91740,7 +90402,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91754,7 +90416,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -91762,7 +90424,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -91778,16 +90440,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -91807,7 +90469,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91816,12 +90478,12 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -91829,7 +90491,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -91845,16 +90507,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -91874,7 +90536,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91883,25 +90545,25 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8Ee3C0bB-F103-0Ef733520578AE83eCaB\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"C4f2Dac7-DbE6-eAbf2CDC-c9d6BEB6538E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"ejwJ4LM\u2005\",\n \"organizationId\": \"0df73669-edda-eF3864ac9862440faA42\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"8bDcC549FC739ECD-f8543504d5f1a1AB\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"cF7A7fB0-A40e7f87-bAda-eedcEf7C223c\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fF0e57c70Ac2-fcfF-bBBB1d4cdB0C23b0\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"EEEbe564-2D11Fb420f0D-648cEcB1BAde\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"2\\u000b\",\n \"organizationId\": \"9db0a46C-5dA6-52e31A1A-7003518853Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0EDC2287-A9Cd3bAC8ECDA6aEFCAFA5a4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"a40d883E-4c46-4d19Bf55A285f94EE3d4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -91912,16 +90574,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -91941,7 +90603,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -91950,12 +90612,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -91963,7 +90625,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -91979,16 +90641,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -92008,7 +90670,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92017,12 +90679,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -92030,7 +90692,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -92046,16 +90708,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -92075,7 +90737,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92084,25 +90746,25 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"active\": \"\",\n \"name\": \"G\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"f022FEbF-C7fE-287F-D8aA-BBb0BdEb8e6b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\",\n \"organizationId\": \"7b824EdE-d1ED-a42BbC92-3EEABFBBCB3d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"d3\",\n \"organizationId\": \"5dB8EB9d030DfEbEDef4E1cB2b2047FD\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"sfI1S\\r\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"fC4F8fE9ABEB-d7cd-aCeaE6aa3EfFfC8C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"fK9G\\r6\",\n \"organizationId\": \"9fe3E6f0d92D90DE-d65f5CeD10a2e2f2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"A51ad34Bde6DD200-A92a-AfdF441D0ca3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -92113,16 +90775,16 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, @@ -92142,7 +90804,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92151,12 +90813,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" } ] }, { - "name": "Create a new Skill Profile", + "name": "Create a new Skill", "request": { "body": { "mode": "raw", @@ -92166,17 +90828,17 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Create a new Skill Profile in a given organization.", + "description": "Create a new Skill in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -92187,9 +90849,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92201,17 +90925,17 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -92221,15 +90945,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "*/*" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92241,9 +90965,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92252,12 +91038,12 @@ ] } }, - "status": "Forbidden" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -92265,7 +91051,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -92275,15 +91061,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92295,9 +91081,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92306,7 +91154,7 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -92329,15 +91177,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92349,9 +91197,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92365,7 +91275,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -92373,7 +91283,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -92383,15 +91293,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92403,9 +91313,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92414,12 +91386,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -92427,7 +91399,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -92437,15 +91409,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92457,9 +91429,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92468,20 +91502,20 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -92491,16 +91525,16 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "*/*" + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -92511,9 +91545,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92522,12 +91618,12 @@ ] } }, - "status": "Created" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -92535,7 +91631,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -92545,15 +91641,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -92565,9 +91661,71 @@ "path": [ "organization", ":orgid", - "skill-profile" + "skill" + ], + "query": [ + { + "description": "Skill configuration data", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data", + "key": "lastUpdatedTime", + "value": "" + } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile", + "raw": "{{baseUrl}}/organization/:orgid/skill?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92576,12 +91734,12 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" } ] }, { - "name": "Bulk save Skill Profile(s)", + "name": "Bulk save Skill(s)", "request": { "body": { "mode": "raw", @@ -92591,9 +91749,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete Skill Profile(s) in bulk in a given organization.", + "description": "Create, Update or delete Skill(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -92612,10 +91770,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92629,7 +91787,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -92637,7 +91795,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -92647,7 +91805,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92667,10 +91825,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92679,20 +91837,20 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -92702,7 +91860,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92711,7 +91869,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -92722,10 +91880,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92734,12 +91892,12 @@ ] } }, - "status": "Forbidden" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -92747,7 +91905,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -92757,7 +91915,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92777,10 +91935,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92789,12 +91947,12 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -92802,7 +91960,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -92812,7 +91970,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92832,10 +91990,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92844,12 +92002,12 @@ ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -92857,7 +92015,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -92867,7 +92025,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92887,10 +92045,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92899,20 +92057,20 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -92922,7 +92080,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92931,7 +92089,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -92942,10 +92100,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -92954,12 +92112,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -92967,7 +92125,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -92977,7 +92135,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"eC7c3FDe-1aA2-80B8EEEAf5c7DaD9CECe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u2006 e\",\n \"organizationId\": \"FcF4B233EF6c4CB9bfC1-ce13cDaaAEB2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\ufeffWX\u180eGje1\u2029\",\n \"organizationId\": \"15abcd4e7104b341-4eD7D18ffa78a0da\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"5wj\u20068\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"2872405c-4da35a5f9b4595d2a36dDbf6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\ufeffYU\",\n \"organizationId\": \"97C85ABe-dB22b09A6A533C0FaD07F6e7\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"p5\",\n \"organizationId\": \"1Ab291E0791D0e1e4a76A4Dc25636757\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -92997,10 +92155,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93009,14 +92167,14 @@ ] } }, - "status": "Conflict" + "status": "Forbidden" } ] }, { - "name": "Bulk export Skill Profile(s)", + "name": "Bulk export Skill(s)", "request": { - "description": "Export all Skill Profile(s) in a given organization.", + "description": "Export all Skill(s) in a given organization.", "header": [ { "key": "Accept", @@ -93031,7 +92189,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93046,7 +92204,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93060,60 +92218,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "skill-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -93121,7 +92226,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -93137,7 +92242,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93152,7 +92257,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93161,11 +92266,11 @@ ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"activeSkills\": [\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n },\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n }\n ],\n \"activeEnumSkills\": [\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"activeSkills\": [\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n },\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n }\n ],\n \"activeEnumSkills\": [\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -93190,7 +92295,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93205,7 +92310,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93243,7 +92348,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93258,7 +92363,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93272,7 +92377,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -93280,7 +92385,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -93296,7 +92401,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93311,7 +92416,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93320,12 +92425,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -93333,7 +92438,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -93349,7 +92454,7 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", "bulk-export" ], "query": [ @@ -93364,7 +92469,7 @@ "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93373,21 +92478,74 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" } ] }, { - "name": "Get specific Skill Profile by ID", + "name": "Purge inactive Skill(s)", "request": { - "description": "Retrieve an existing Skill Profile by ID in a given organization.", + "description": "Purge inactive Skill(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93395,52 +92553,47 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93448,35 +92601,31 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 409, "cookie": [], "header": [ { @@ -93484,7 +92633,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Similar entity is already present", "originalRequest": { "header": [ { @@ -93492,7 +92641,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93500,35 +92649,31 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -93536,7 +92681,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -93544,7 +92689,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93552,35 +92697,31 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -93588,7 +92729,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -93596,7 +92737,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93604,35 +92745,31 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -93640,7 +92777,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -93648,7 +92785,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93656,35 +92793,79 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill", + "purge-inactive-entities" + ], + "query": [ { - "description": "Resource ID of the Skill Profile.", - "key": "id" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -93692,7 +92873,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -93700,7 +92881,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -93708,58 +92889,40 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id" + "skill", + "purge-inactive-entities" ], "query": [ { - "description": "If set to true returns skill details", - "key": "includeSkillDetails", - "value": "false" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] }, { - "name": "Update specific Skill Profile by ID", + "name": "Get specific Skill by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, - "description": "Update an existing Skill Profile by ID in a given organization.", + "description": "Retrieve an existing Skill by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -93767,10 +92930,10 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -93778,7 +92941,7 @@ "value": "" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id", "value": "" } @@ -93789,7 +92952,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -93797,29 +92960,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -93827,28 +92976,28 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 404, "cookie": [], "header": [ { @@ -93856,29 +93005,15 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -93886,28 +93021,28 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -93915,29 +93050,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -93945,58 +93066,44 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -94004,58 +93111,44 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -94063,23 +93156,23 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -94094,27 +93187,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -94122,36 +93201,151 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, "status": "Internal Server Error" + } + ] + }, + { + "name": "Update specific Skill by ID", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, + "description": "Update an existing Skill by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill", + ":id" + ], + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the Skill.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"Yk\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"2C4dDa1DDdcF-07092B27888e1E8AB62c\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"\u3000\",\n \"organizationId\": \"a50D61F11A6E-FE1C4FF5-4DBBCb84cEcC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\",\n \"organizationId\": \"1ba73deA-c515e3D0-b3Ee9db9ad8998C3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -94161,15 +93355,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "*/*" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -94181,28 +93375,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 412, "cookie": [], "header": [ { @@ -94210,7 +93466,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -94220,15 +93476,15 @@ "language": "json" } }, - "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -94240,67 +93496,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Bad Request" - } - ] - }, - { - "name": "Delete specific Skill Profile by ID", - "request": { - "description": "Delete an existing Skill Profile by ID in a given organization.", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "skill-profile", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - }, - { - "description": "Resource ID of the Skill Profile.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ + "status": "Precondition Failed" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 400, "cookie": [], "header": [ { @@ -94308,15 +93587,29 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94324,28 +93617,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -94353,15 +93708,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94369,28 +93738,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -94398,15 +93829,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94414,28 +93859,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -94443,15 +93950,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94459,63 +93980,90 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Skill configuration data for update", + "key": "active", + "value": "" }, { - "description": "Resource ID of the Skill Profile.", - "key": "id" + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, - "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "skill-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "No Content" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -94523,15 +94071,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94539,23 +94101,85 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -94570,13 +94194,27 @@ ], "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"\u2007stw3j6\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"enum\",\n \"organizationId\": \"B37D27Ac7a5f-F92b-5108d847a1C5a8D1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"DQ-\",\n \"organizationId\": \"Cb9a109bedBd-46ED-6374Aa37dE73Cc1e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n },\n {\n \"name\": \"\u180edGO O\",\n \"organizationId\": \"D11E24edE4b8-32C81e0B-788CD2Ba3461\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\"\n }\n ],\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "DELETE", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -94584,17 +94222,79 @@ "path": [ "organization", ":orgid", - "skill-profile", + "skill", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", + "query": [ + { + "description": "Skill configuration data for update", + "key": "active", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "name", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "serviceLevelThreshold", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "skillType", + "value": "enum" + }, + { + "description": "Skill configuration data for update", + "key": "organizationId", + "value": "ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb" + }, + { + "description": "Skill configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "enumSkillValues", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill configuration data for update", + "key": "dynamicSkill", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id?active=&name=&serviceLevelThreshold=&skillType=enum&organizationId=ACc6aeDF-6A805ecF-38ba-3EA0725cbDBb&id=&version=&description=&enumSkillValues=[object Object],[object Object]&dynamicSkill=&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Skill Profile.", + "description": "Resource ID of the Skill.", "key": "id" } ] @@ -94605,16 +94305,16 @@ ] }, { - "name": "List references for a specific Skill Profile", + "name": "Delete specific Skill by ID", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization.", + "description": "Delete an existing Skill by ID in a given organization.", "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94622,28 +94322,10 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -94651,7 +94333,7 @@ "value": "" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id", "value": "" } @@ -94662,7 +94344,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -94670,7 +94352,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -94678,7 +94360,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94686,62 +94368,44 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94749,46 +94413,28 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "OK" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -94796,7 +94442,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -94804,7 +94450,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94812,46 +94458,28 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -94859,7 +94487,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -94867,7 +94495,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94875,41 +94503,23 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -94930,7 +94540,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -94938,35 +94548,17 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" - ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "skill", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] @@ -94977,7 +94569,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -94985,7 +94577,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -94993,7 +94585,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -95001,48 +94593,65 @@ "path": [ "organization", ":orgid", - "skill-profile", - ":id", - "incoming-references" + "skill", + ":id" ], - "query": [ - { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Resource ID of the Skill.", + "key": "id" } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "skill", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/skill/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "Resource ID of the Skill.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "No Content" } ] }, { - "name": "List Skill Profile(s)", + "name": "List references for a specific Skill", "request": { - "description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of all entities that have reference to an existing Skill by ID in a given organization.", "header": [ { "key": "Accept", @@ -95057,23 +94666,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95085,41 +94685,41 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -95130,23 +94730,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95158,28 +94749,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -95187,7 +94777,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -95203,23 +94793,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95231,28 +94812,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -95260,7 +94840,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -95276,23 +94856,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95304,28 +94875,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -95333,7 +94903,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -95349,23 +94919,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95377,28 +94938,27 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -95406,7 +94966,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -95422,23 +94982,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95450,41 +95001,40 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"D5B511Cb-1Acd-f1FAED1D-EAF3D1fD1a73\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"A98Bc2FB-EfB7-3D20-29b5A4628cF6E7cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"p\",\n \"organizationId\": \"D9FB3A6d-bf9bC3Ad-52bD00E5dFC3Aebb\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"1D10739CBBC3-58b00dEc-0AFe126F021C\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0e7Be0bB69aB-F6eD-7b10-210FEE0AD06E\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"08cF0de8-8F88-51BC93D8-57aC5fCebDa2\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FDcc27dF7d0Ca0Fb1DC6-FFD9c7a2ff88\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"cbODWp8\",\n \"organizationId\": \"13A490C5-bB8EE3dE761b-9ED88540Ff06\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"bEafF6fa65771d5C-EEFB97C569B47ef3\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"9cAfBdc4D6F04099-24f18Ce27512cF01\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -95495,23 +95045,14 @@ "path": [ "organization", ":orgid", - "v2", - "skill-profile" + "skill", + ":id", + "incoming-references" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (activeSkills,activeEnumSkills)", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", "value": "" }, { @@ -95523,35 +95064,29 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" } ] - } - ], - "name": "Skill Profile" - }, - { - "item": [ + }, { - "name": "List Team(s)", + "name": "List Skill(s)", "request": { - "description": "Retrieve a list of Team(s) in a given organization.", + "description": "Retrieve a list of Skill(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.", "header": [ { "key": "Accept", @@ -95566,19 +95101,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95595,7 +95136,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95609,7 +95150,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -95617,7 +95158,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -95633,19 +95174,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95662,7 +95209,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95671,7 +95218,7 @@ ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -95700,19 +95247,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95729,7 +95282,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95743,7 +95296,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -95751,7 +95304,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -95767,19 +95320,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95796,7 +95355,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95805,7 +95364,7 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -95834,19 +95393,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95863,7 +95428,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95877,7 +95442,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -95885,7 +95450,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -95901,19 +95466,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95930,7 +95501,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -95939,11 +95510,11 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", - "body": "[\n {\n \"organizationId\": \"4d7FCa351E25-3BE0C68C877CBe2FFf00\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Ae2a8B3FCaDd4af0-EC8b-d06F5325FED4\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"1e3d0bE7-35a7-d5adaeA4-cd9cc3b8Eee7\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"cFBffF8F-aEADac83-5f4C5fFdaAba8a9F\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"IN_SERVICE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e29aAC0b43aF-E54D-0B3A-Eb7c1cdDfd7E\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"a51A4cc6-FfaC-C529c68e5d546cEB2efe\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"\u2028Xu\u2002PZT\u2002\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Proficiency\",\n \"organizationId\": \"80F9a2AEFEeBBddA-aeB0e27c14eFE032\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \"lxz\",\n \"organizationId\": \"AbA9f0F48C821e9252D7e5c90DA3bDF0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"paw\ufeffA\",\n \"organizationId\": \"28c20b66-CfE1BbEB-124c-04fa02F8deDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"2A.\ufeff\u202frKy\u2005V\",\n \"serviceLevelThreshold\": \"\",\n \"skillType\": \"Text\",\n \"organizationId\": \"b0fEc6a3-f3575B61-2e734FcB02cF768f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"enumSkillValues\": [\n {\n \"name\": \".\\nP\",\n \"organizationId\": \"C3a2D0AA6Bb6-3AB9E75b6979882CDc0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2029s\",\n \"organizationId\": \"DAaD8e4d8Af4-eeEcdbae-099BC8ED788a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -95968,19 +95539,25 @@ "path": [ "organization", ":orgid", - "team" + "v2", + "skill" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -95997,7 +95574,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96011,27 +95588,12 @@ ] }, { - "name": "Create a new Team", + "name": "Populate json-attributes field for a given skill-id of an organization", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, - "description": "Create a new Team in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -96042,14 +95604,19 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "key": "id", + "value": "" } ] } @@ -96058,7 +95625,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -96066,23 +95633,9 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -96096,50 +95649,42 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -96150,18 +95695,24 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Created" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -96176,21 +95727,7 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -96204,13 +95741,19 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } @@ -96220,7 +95763,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -96228,23 +95771,9 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -96258,23 +95787,29 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -96282,23 +95817,9 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Similar entity is already present", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -96312,52 +95833,34 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Conflict" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 200, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Similar entity is already present", + "header": [], + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -96366,23 +95869,29 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Conflict" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -96390,23 +95899,9 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" @@ -96420,46 +95915,43 @@ "path": [ "organization", ":orgid", - "team" + "skill", + "populate-json-attr", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team", + "raw": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "key": "orgid", + "value": "" + }, + { + "key": "id", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] - }, + } + ], + "name": "Skill" + }, + { + "item": [ { - "name": "Bulk save Team(s)", + "name": "List Skill Profile(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Team(s) in bulk in a given organization.", + "description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96467,10 +95959,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96482,39 +96000,25 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96522,10 +96026,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96534,12 +96064,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -96547,29 +96077,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96577,10 +96093,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96589,42 +96131,28 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"organizationId\": \"F0EE2a1c-18fEC2831fFd-BbbeAadbc7E1\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\u2028E\ufeffRW\u1680\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"FF46f8C5-8Cdc-fdeE-5d763d9B4Cb443AC\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"ME\u00a0Y\",\n \"description\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96632,10 +96160,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96644,7 +96198,7 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -96659,27 +96213,13 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96687,10 +96227,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96714,27 +96280,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96742,10 +96294,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96759,7 +96337,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 403, "cookie": [], "header": [ { @@ -96767,29 +96345,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -96797,10 +96361,36 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96809,12 +96399,106 @@ ] } }, - "status": "Conflict" + "status": "Forbidden" + } + ] + }, + { + "name": "Create a new Skill Profile", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, + "description": "Create a new Skill Profile in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile" + ], + "query": [ + { + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -96822,7 +96506,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -96832,15 +96516,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -96852,10 +96536,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk" + "skill-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "query": [ + { + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96864,58 +96594,12 @@ ] } }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Bulk export Team(s)", - "request": { - "description": "Export all Team(s) in a given organization.", - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "team", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ + "status": "Forbidden" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -96923,15 +96607,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -96939,22 +96637,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -96963,28 +96695,42 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"siteName\": \"\",\n \"name\": \"\",\n \"teamType\": \"\",\n \"multimediaProfileName\": \"\",\n \"skillProfileName\": \"\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutName\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n },\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n }\n ]\n },\n {\n \"siteName\": \"\",\n \"name\": \"\",\n \"teamType\": \"\",\n \"multimediaProfileName\": \"\",\n \"skillProfileName\": \"\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutName\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n },\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n }\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -96992,22 +96738,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97016,12 +96796,12 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -97029,15 +96809,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -97045,22 +96839,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97069,12 +96897,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -97082,15 +96910,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -97098,22 +96940,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97122,28 +96998,42 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "Created", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", + "value": "*/*" + }, + { + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -97151,22 +97041,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97175,12 +97099,12 @@ ] } }, - "status": "Not Found" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -97188,15 +97112,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -97204,22 +97142,56 @@ "path": [ "organization", ":orgid", - "team", - "bulk-export" + "skill-profile" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Skill profile configuration data", + "key": "activeSkills", + "value": "[object Object],[object Object]" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "Skill profile configuration data", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data", + "key": "lastUpdatedTime", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97228,15 +97200,29 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] }, { - "name": "Purge inactive Team(s)", + "name": "Bulk save Skill Profile(s)", "request": { - "description": "Purge inactive Team(s) older than the configured interval for a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Skill Profile(s) in bulk in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" @@ -97250,17 +97236,10 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "skill-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97274,7 +97253,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -97282,9 +97261,23 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -97298,17 +97291,10 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "skill-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97317,12 +97303,12 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -97330,9 +97316,23 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -97346,17 +97346,10 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "skill-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97365,12 +97358,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -97378,9 +97371,23 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -97394,17 +97401,10 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "skill-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97413,12 +97413,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -97426,9 +97426,23 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -97442,17 +97456,10 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "skill-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97461,25 +97468,39 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -97490,17 +97511,65 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" + "skill-profile", + "bulk" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "variable": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Multi-Status", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97509,7 +97578,7 @@ ] } }, - "status": "OK" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", @@ -97524,7 +97593,21 @@ ], "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"daBFD5CD4AC9FbBcAD9Ac2fee2c5a6f9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"8e6E90d9-93A5eAaC442B3FD37d46Bd0e\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"NPK bs5M\",\n \"organizationId\": \"e0b47eC04dcfB58C2FAdFCa078F04E19\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"19a89abA7bf8-ffDFcaFCdDfEAcc2d189\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"06A2DFAD-cA0C-D086967d0e3CBAFdce10\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"1C412CDeD8AE-9cb0-8Bd6b9acCeC4bdc9\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"d408a0a8e80C-681C-da9E-33D6Be085e26\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"u \",\n \"organizationId\": \"B7Fd49ee-Dd4cf18F8d702CBE5ADd5d11\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"418bbce3-CD14-66722ac39a77e37A22af\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0c76939D-d827fbBCD24F-45D3DdBc2D28\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -97538,17 +97621,109 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" + "skill-profile", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Bulk export Skill Profile(s)", + "request": { + "description": "Export all Skill Profile(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97557,7 +97732,113 @@ ] } }, - "status": "Conflict" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"activeSkills\": [\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n },\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n }\n ],\n \"activeEnumSkills\": [\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"activeSkills\": [\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n },\n {\n \"skillName\": \"\",\n \"skillValue\": \"\"\n }\n ],\n \"activeEnumSkills\": [\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n },\n {\n \"skillName\": \"\",\n \"skillValues\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -97578,7 +97859,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -97586,17 +97867,22 @@ "path": [ "organization", ":orgid", - "team", - "purge-inactive-entities" + "skill-profile", + "bulk-export" ], "query": [ { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97606,13 +97892,119 @@ } }, "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "skill-profile", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" } ] }, { - "name": "Get specific Team by ID", + "name": "Get specific Skill Profile by ID", "request": { - "description": "Retrieve an existing Team by ID in a given organization.", + "description": "Retrieve an existing Skill Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -97627,10 +98019,17 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97638,7 +98037,7 @@ "value": "" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id", "value": "" } @@ -97647,22 +98046,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -97673,23 +98072,30 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -97718,17 +98124,24 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] @@ -97737,22 +98150,22 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -97763,28 +98176,35 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -97792,7 +98212,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -97808,28 +98228,35 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -97837,7 +98264,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -97853,28 +98280,35 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -97882,7 +98316,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -97898,28 +98332,35 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "If set to true returns skill details", + "key": "includeSkillDetails", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] }, { - "name": "Update specific Team by ID", + "name": "Update specific Skill Profile by ID", "request": { "body": { "mode": "raw", @@ -97929,17 +98370,17 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update an existing Team by ID in a given organization.", + "description": "Update an existing Skill Profile by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -97950,10 +98391,57 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -97961,7 +98449,7 @@ "value": "" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id", "value": "" } @@ -97972,7 +98460,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -97980,7 +98468,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -97990,15 +98478,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98010,28 +98498,75 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 412, "cookie": [], "header": [ { @@ -98039,7 +98574,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -98049,15 +98584,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98069,28 +98604,75 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -98098,7 +98680,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -98108,15 +98690,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98128,36 +98710,83 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -98167,16 +98796,16 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "*/*" + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -98187,36 +98816,83 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"fCcC24ac74fc3eed-2cc4b00abDA0DF5E\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"a5b582C83dc5B94Fe5826824dFadC7ff\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"\u3000\\t\",\n \"organizationId\": \"76E4016219EB8beBadc2-EFF8bb2bdDfE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"Dc734A0cEA85-60Ea-f504-f1a29e9E43Be\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"C5e83D8c-217d375d95EB-f774aaEE4DEc\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -98226,15 +98902,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "*/*" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98246,28 +98922,75 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -98275,7 +98998,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -98285,15 +99008,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98305,28 +99028,75 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -98334,7 +99104,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -98344,15 +99114,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98364,28 +99134,75 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 400, "cookie": [], "header": [ { @@ -98393,7 +99210,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -98403,15 +99220,15 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + "raw": "{\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FFDc2A22-c12f-7F8a4671B2e788fAa9DC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"CcBe85EdfFA2-A3ddadb7-7D08cBf0bC5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"crS_O4NAx\",\n \"organizationId\": \"FE6Dee85-3CcA-8cBBD9b4-Ba54f1AeA12C\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"2bE3F99f-D4aB-9EDffB5BdBD9DEC0EF31\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"14f2ABfB-beA8-3db9-caFD-3CaECEd5AB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -98423,30 +99240,77 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "query": [ + { + "description": "Skill profile configuration data for update", + "key": "activeSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "name", + "value": "d\fg8\u202fm\r" + }, + { + "description": "Skill profile configuration data for update", + "key": "organizationId", + "value": "BB2f1df37fBd7D09-0d4e-c8824cbc0fd0" + }, + { + "description": "Skill profile configuration data for update", + "key": "id", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "version", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "description", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "activeEnumSkills", + "value": "[object Object],[object Object]" + }, + { + "description": "Skill profile configuration data for update", + "key": "createdTime", + "value": "" + }, + { + "description": "Skill profile configuration data for update", + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id?activeSkills=[object Object],[object Object]&name=d\fg8\u202fm\r&organizationId=BB2f1df37fBd7D09-0d4e-c8824cbc0fd0&id=&version=&description=&activeEnumSkills=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Bad Request" } ] }, { - "name": "Delete specific Team by ID", + "name": "Delete specific Skill Profile by ID", "request": { - "description": "Delete an existing Team by ID in a given organization.", + "description": "Delete an existing Skill Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -98461,10 +99325,10 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -98472,7 +99336,7 @@ "value": "" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id", "value": "" } @@ -98483,7 +99347,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 412, "cookie": [], "header": [ { @@ -98491,7 +99355,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -98507,63 +99371,73 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], - "header": [], - "name": "No Content", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" ], "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "No Content" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 500, "cookie": [], "header": [ { @@ -98571,7 +99445,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -98587,23 +99461,23 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -98632,17 +99506,17 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] @@ -98651,24 +99525,14 @@ "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "No Content", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -98677,28 +99541,28 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "No Content" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -98706,7 +99570,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -98722,28 +99586,28 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -98751,7 +99615,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -98767,30 +99631,30 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the Team.", + "description": "Resource ID of the Skill Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" } ] }, { - "name": "List references for a specific Team", + "name": "List references for a specific Skill Profile", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Team by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -98805,7 +99669,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -98826,7 +99690,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -98869,7 +99733,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -98890,7 +99754,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -98906,22 +99770,22 @@ "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -98932,7 +99796,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -98953,7 +99817,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -98966,12 +99830,12 @@ ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -98979,7 +99843,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -98995,7 +99859,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -99016,7 +99880,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99029,12 +99893,12 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -99042,7 +99906,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -99058,7 +99922,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -99079,7 +99943,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99092,12 +99956,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -99105,7 +99969,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -99121,7 +99985,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -99142,7 +100006,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99155,25 +100019,25 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -99184,7 +100048,7 @@ "path": [ "organization", ":orgid", - "team", + "skill-profile", ":id", "incoming-references" ], @@ -99205,7 +100069,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99218,14 +100082,14 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" } ] }, { - "name": "List Team(s)", + "name": "List Skill Profile(s)", "request": { - "description": "Retrieve a list of Team(s) in a given organization.", + "description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.", "header": [ { "key": "Accept", @@ -99241,16 +100105,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99269,23 +100133,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99299,7 +100153,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -99307,7 +100161,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -99324,16 +100178,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99352,23 +100206,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99377,12 +100221,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -99390,7 +100234,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -99407,16 +100251,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99435,23 +100279,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99460,7 +100294,7 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -99490,16 +100324,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99518,23 +100352,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99546,22 +100370,22 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"cCAf4fef-4A7c4F0d-77Ae-AB5eC2f98C65\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"CAPACITY\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"3F7eaA0AF76c6AFAAcd9-F0e612Acc8B8\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e91FfCaC-0Be4-8a6F-6fDf-FE73bc7BbEC9\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"ec42CBd0cfA7-8895bAa6BA94FE9ed09b\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"IN_SERVICE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dc0F7aE7-6392-6eFe2c0bDdf95EAEeD8E\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"A7bcdFcc-52A9-A9D2DECE-5eDe058b09EC\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -99573,16 +100397,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99601,23 +100425,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99626,12 +100440,12 @@ ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -99639,7 +100453,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -99656,16 +100470,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99684,23 +100498,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99709,25 +100513,25 @@ ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"D5B511Cb-1Acd-f1FAED1D-EAF3D1fD1a73\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"A98Bc2FB-EfB7-3D20-29b5A4628cF6E7cc\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"p\",\n \"organizationId\": \"D9FB3A6d-bf9bC3Ad-52bD00E5dFC3Aebb\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"1D10739CBBC3-58b00dEc-0AFe126F021C\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"0e7Be0bB69aB-F6eD-7b10-210FEE0AD06E\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"activeSkills\": [\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"08cF0de8-8F88-51BC93D8-57aC5fCebDa2\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n },\n {\n \"booleanValue\": \"\",\n \"skillId\": \"\",\n \"organizationId\": \"FDcc27dF7d0Ca0Fb1DC6-FFD9c7a2ff88\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"proficiencyValue\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillName\": \"\"\n }\n ],\n \"name\": \"cbODWp8\",\n \"organizationId\": \"13A490C5-bB8EE3dE761b-9ED88540Ff06\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"activeEnumSkills\": [\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"bEafF6fa65771d5C-EEFB97C569B47ef3\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n },\n {\n \"enumSkillValueId\": \"\",\n \"organizationId\": \"9cAfBdc4D6F04099-24f18Ce27512cF01\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"enumSkillName\": \"\",\n \"enumSkillValue\": \"\",\n \"enumSkillId\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -99739,16 +100543,16 @@ "organization", ":orgid", "v2", - "team" + "skill-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, activeSkills, activeEnumSkills, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (userIds, queueRankings)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)", "key": "attributes", "value": "" }, @@ -99767,23 +100571,13 @@ "key": "pageSize", "value": "100" }, - { - "description": "supervisorView flag honours user-profile team access rights if supervisor or administrator who has contact center enabled.", - "key": "supervisorView", - "value": "false" - }, - { - "description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ", - "key": "provisioningView", - "value": "false" - }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/skill-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99792,19 +100586,19 @@ ] } }, - "status": "Forbidden" + "status": "OK" } ] } ], - "name": "Team" + "name": "Skill Profile" }, { "item": [ { - "name": "List User Profile(s)", + "name": "List Team(s)", "request": { - "description": "Retrieve a list of User Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Team(s) in a given organization.", "header": [ { "key": "Accept", @@ -99819,26 +100613,36 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -99852,7 +100656,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -99860,7 +100664,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -99876,39 +100680,50 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -99916,7 +100731,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -99932,39 +100747,50 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -99972,7 +100798,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -99988,52 +100814,63 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "[\n {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"\ufeff4cVCr\\r\",\n \"profileType\": \"STANDARD_AGENT\",\n \"organizationId\": \"DAb0611175bc-4059E95a16028716cF94\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"25C5A7eF-Ced1eADDCae6Ed6F2ba91c9c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"1AC215B1-adc9-dD0c-DF64EDa4D759ae3d\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4ad3EcfcF811-Ef17f09F-D8F99aC4c918\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"23a1a1Ad-84E522Ed0B9CDD95CCb12468\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"DfbA9cFaA883463BB6ef-c744E7aDe1ed\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"54514925-fDd1-CA0957bBF9aEB59a7E7b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"ALL\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"yf8l7\u2008G60\",\n \"profileType\": \"STANDARD_AGENT\",\n \"organizationId\": \"CbEFEeea5BD5528D88C6-2FBeCD98DeF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"a70ae62c676a-fdDB5eAB3D68Eee23B4b\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"DBDFF32A8d38-Eefd-2fec-BcEDB3C1F9cd\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"8f9Da531-8edF5c36-06c1581e1CE4CA88\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"Ff8cd03A-AAe1eFB0-C6DF-3b8FEcf198C1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"A7B5A9BC8Ee401026DAB3705Cc4C8aAf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"54b1Fdf06D0E9Cc44fec9FF58bFC0ad9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n }\n]", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -100044,39 +100881,50 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -100084,7 +100932,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -100100,52 +100948,63 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"organizationId\": \"b9A1F0e6-DF0cf9ff-D5Ec-19AFC5EeCb16\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"CAPACITY\",\n \"teamStatus\": \"IN_SERVICE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"8BA66C72733EE2Ef-7a82C9E27ED4b38B\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"2eb3d7FCA828-8580Ac4d-6eFC94A9aE3a\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"e634aE32-D09dae943124Ee2deF966A1B\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"CAPACITY\",\n \"teamStatus\": \"IN_SERVICE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"D67efd83e1B82d7592Cf-b26DaD558e18\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"70CAAb0fa8a6a68d6Ccc309FBbfd7Ec3\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -100156,39 +101015,50 @@ "path": [ "organization", ":orgid", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/team?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "OK" } ] }, { - "name": "Bulk save User Profile(s)", + "name": "Create a new Team", "request": { "body": { "mode": "raw", @@ -100198,17 +101068,17 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, - "description": "Create, Update or delete User Profile(s) in bulk in a given organization.", + "description": "Create a new Team in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -100219,10 +101089,91 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100236,7 +101187,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -100244,7 +101195,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -100254,15 +101205,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100274,31 +101225,113 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -100308,15 +101341,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "*/*" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100328,23 +101361,105 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -100352,7 +101467,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -100362,15 +101477,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100382,23 +101497,105 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -100406,7 +101603,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -100416,15 +101613,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100436,31 +101633,113 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"DELETE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Multi-Status", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -100470,16 +101749,16 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", - "value": "*/*" + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -100490,18 +101769,100 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -100524,15 +101885,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100544,12 +101905,94 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -100560,7 +102003,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -100568,7 +102011,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -100578,15 +102021,15 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -100598,32 +102041,128 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk" + "team" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Bad Request" + "status": "Forbidden" } ] }, { - "name": "Bulk export User Profiles", + "name": "Bulk save Team(s)", "request": { - "description": "Export all user profiles in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Team(s) in bulk in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -100631,22 +102170,10 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "team", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100659,8 +102186,8 @@ "response": [ { "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"b0aBeCE8-f847ad116c39305Ba3b42b3e\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"B64fAB5c-c3ccfc85Bae8-8dcA22E1DDA6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"cbE0254A-2AFE-6549e4f2-7C658592bbb8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"aD80c7e6bb232BC2-F2a0-F1cE5EF5fb5d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"1d5C21bcdFDE-B3bCfB34dB2C56F3DDb5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"61C506A8-aBB1E37c-eeEAda8AE0b0f4ef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"SPECIFIC\",\n \"permissionAccessLevel\": \"NONE\",\n \"resourceAccessLevel\": \"ALL\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4f0BfA41-5DCFe3DF-935B-2a32670bEb72\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"89beDaA8-1FDc-3f7AA9fb8af62EfC11F1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"bCaCbdb3969F02F4-7Fc1-aF5b00CC99cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2eEb19BA2Bd95fc1cd6c-63cFAFd2B63c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f3beA255A12c-76696Fbd-0cb6C9eDcf7E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"48fBC57f-a13C-5Bfc-7fea-06DD6400edef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"accessAllEntryPoints\": \"ALL\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"ALL\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"ALL\",\n \"permissionAccessLevel\": \"ALL\",\n \"resourceAccessLevel\": \"NONE\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n }\n ]\n}", - "code": 200, + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { @@ -100668,15 +102195,29 @@ "value": "*/*" } ], - "name": "OK", + "name": "Multi-Status", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -100684,22 +102225,10 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "team", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100708,12 +102237,12 @@ ] } }, - "status": "OK" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -100721,15 +102250,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -100737,22 +102280,10 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "team", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100761,12 +102292,12 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -100774,15 +102305,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -100790,22 +102335,329 @@ "path": [ "organization", ":orgid", - "user-profile", - "bulk-export" + "team", + "bulk" ], - "query": [ + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "variable": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Similar entity is already present", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"5\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"79B67B786ffd-48aC-Eea9DFBc10Da7c2c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"E3ED6e28-CEFa-0bB4-14eBED62F53626AC\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"Fac729059fdff61D-0cEa-6A9EB38CD801\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"a\\nI\u2028Qt\\rR\u1680p\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"IN_SERVICE\",\n \"teamType\": \"AGENT\",\n \"organizationId\": \"eE9bCeAB9Abd-C8C8-55f3-fDe8E1237aBe\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e453c4b9fFf44Cfa-CEEc-Be4be91af2cf\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"De58ECC9D8ECEA051f7b-5e24bCAD59Df\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Bulk export Team(s)", + "request": { + "description": "Export all Team(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", "value": "0" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100814,7 +102666,113 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"siteName\": \"\",\n \"name\": \"\",\n \"teamType\": \"\",\n \"multimediaProfileName\": \"\",\n \"skillProfileName\": \"\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutName\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n },\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n }\n ]\n },\n {\n \"siteName\": \"\",\n \"name\": \"\",\n \"teamType\": \"\",\n \"multimediaProfileName\": \"\",\n \"skillProfileName\": \"\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutName\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n },\n {\n \"queueName\": \"\",\n \"rank\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -100843,7 +102801,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "bulk-export" ], "query": [ @@ -100855,10 +102813,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100896,7 +102854,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "bulk-export" ], "query": [ @@ -100908,10 +102866,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100925,7 +102883,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -100933,7 +102891,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -100949,7 +102907,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "bulk-export" ], "query": [ @@ -100961,10 +102919,10 @@ { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", - "value": "100" + "value": "50" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/bulk-export?page=0&pageSize=50", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -100973,14 +102931,14 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Purge inactive User Profile(s)", + "name": "Purge inactive Team(s)", "request": { - "description": "Purge inactive User Profile(s) older than the configured interval for a given organization.", + "description": "Purge inactive Team(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", @@ -100995,7 +102953,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101005,7 +102963,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -101019,7 +102977,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -101027,7 +102985,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -101043,7 +103001,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101053,20 +103011,21 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -101074,7 +103033,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -101090,7 +103049,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101100,20 +103059,21 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -101121,7 +103081,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -101137,7 +103097,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101147,20 +103107,21 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 400, "cookie": [], "header": [ { @@ -101168,7 +103129,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -101184,7 +103145,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101194,33 +103155,34 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Conflict" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -101231,7 +103193,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101241,20 +103203,21 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -101262,7 +103225,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Similar entity is already present", "originalRequest": { "header": [ { @@ -101278,7 +103241,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101288,33 +103251,34 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Bad Request" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -101325,7 +103289,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", "purge-inactive-entities" ], "query": [ @@ -101335,22 +103299,23 @@ "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities?nextStartId=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "Get specific User Profile by ID", + "name": "Get specific Team by ID", "request": { - "description": "Retrieve an existing User Profile by ID in a given organization.", + "description": "Retrieve an existing Team by ID in a given organization.", "header": [ { "key": "Accept", @@ -101365,10 +103330,10 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -101376,7 +103341,7 @@ "value": "" }, { - "description": "Resource ID of the User Profile.", + "description": "Resource ID of the Team", "key": "id", "value": "" } @@ -101385,22 +103350,22 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"Dc\u20009sC\\r\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"BFa5e280-c9EF-9Ce2bB4eEd3dba9EA522\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"234406BAbaeBbbE3-cb52-9Ca4dFA03cDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"bfBEefea5E4E-80BF-D3AcEcAB70DC34eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0387CB15dEeb-2EFA0E3FAe19ad13C3D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"385fce55CdE4A4e4BDeA-f406C29dFfbB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"E4cA0FA2-e232c977-2F9EbEdeC1F3D852\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FFD7357b-e7Af-cC78bF9e-9adb6F2ACCD2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -101411,26 +103376,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -101438,7 +103405,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -101454,39 +103421,41 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -101497,26 +103466,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -101524,7 +103495,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -101540,21 +103511,23 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -101583,15 +103556,17 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] @@ -101602,7 +103577,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -101610,7 +103585,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -101626,26 +103601,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] }, { - "name": "Update specific User Profile by ID", + "name": "Update specific Team by ID", "request": { "body": { "mode": "raw", @@ -101655,17 +103632,17 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, - "description": "Update an existing User Profile by ID in a given organization.", + "description": "Update an existing Team by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -101676,10 +103653,92 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -101687,7 +103746,7 @@ "value": "" }, { - "description": "Resource ID of the User Profile.", + "description": "Resource ID of the Team.", "key": "id", "value": "" } @@ -101698,7 +103757,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 429, "cookie": [], "header": [ { @@ -101706,7 +103765,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -101716,15 +103775,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -101736,83 +103795,110 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", - "variable": [ + "query": [ { - "key": "orgid" + "key": "active", + "value": "" }, { - "key": "id" - } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"Dc\u20009sC\\r\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"BFa5e280-c9EF-9Ce2bB4eEd3dba9EA522\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"234406BAbaeBbbE3-cb52-9Ca4dFA03cDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"bfBEefea5E4E-80BF-D3AcEcAB70DC34eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0387CB15dEeb-2EFA0E3FAe19ad13C3D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"385fce55CdE4A4e4BDeA-f406C29dFfbB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"E4cA0FA2-e232c977-2F9EbEdeC1F3D852\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FFD7357b-e7Af-cC78bF9e-9adb6F2ACCD2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" } - }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "user-profile", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -101820,7 +103906,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -101830,15 +103916,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -101850,26 +103936,110 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -101877,7 +104047,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -101887,15 +104057,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -101907,34 +104077,118 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"organizationId\": \"dadcb7Cf-BC9fa10c-1DDFfD38A9FBdCc3\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dda22A20-8a055fc1-3d7DE9acC3C1Dec2\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dbEDCf4aAbe4547F47d8-2bCFd8d9edCF\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -101944,15 +104198,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "Accept", + "value": "*/*" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -101964,21 +104218,105 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", - "variable": [ + "query": [ { - "key": "orgid" + "key": "active", + "value": "" }, { - "key": "id" - } + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Team.", + "key": "id" + } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -102001,15 +104339,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -102021,15 +104359,99 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] @@ -102040,7 +104462,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -102048,7 +104470,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -102058,15 +104480,15 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -102078,26 +104500,110 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -102105,7 +104611,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -102115,16 +104621,157 @@ "language": "json" } }, - "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" }, "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "team", + ":id" + ], + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the Team.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"active\": \"\",\n \"dialedNumber\": \"\",\n \"name\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"siteId\": \"\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"teamType\": \"CAPACITY\",\n \"organizationId\": \"1debEE5f-bFe6-6aa1CaEa-8Aae3F58C02c\",\n \"id\": \"\",\n \"version\": \"\",\n \"capacity\": \"\",\n \"desktopLayoutId\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"eF0dE54Dc1718dE4a8fDE41e3a28e5fA\",\n \"id\": \"\",\n \"version\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"76F2F344-0BaB-F9Efa8a8C31F8B1B5d7d\",\n \"id\": \"\",\n \"version\": \"\"\n }\n ]\n}" + }, + "header": [ { "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -102135,28 +104782,112 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "query": [ + { + "key": "active", + "value": "" + }, + { + "key": "name", + "value": "" + }, + { + "key": "rankQueuesForTeam", + "value": "" + }, + { + "key": "siteId", + "value": "" + }, + { + "key": "teamStatus", + "value": "NOT_AVAILABLE" + }, + { + "key": "teamType", + "value": "AGENT" + }, + { + "key": "organizationId", + "value": "6B6E2bDc1CB0acFb-496b43ffA2EBCCb7" + }, + { + "key": "id", + "value": "" + }, + { + "key": "version", + "value": "" + }, + { + "key": "dialedNumber", + "value": "" + }, + { + "key": "capacity", + "value": "" + }, + { + "key": "desktopLayoutId", + "value": "" + }, + { + "key": "skillProfileId", + "value": "" + }, + { + "key": "multiMediaProfileId", + "value": "" + }, + { + "key": "userIds", + "value": "," + }, + { + "key": "description", + "value": "" + }, + { + "key": "systemDefault", + "value": "" + }, + { + "key": "queueRankings", + "value": "[object Object],[object Object]" + }, + { + "key": "createdTime", + "value": "" + }, + { + "key": "lastUpdatedTime", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/team/:id?active=&name=&rankQueuesForTeam=&siteId=&teamStatus=NOT_AVAILABLE&teamType=AGENT&organizationId=6B6E2bDc1CB0acFb-496b43ffA2EBCCb7&id=&version=&dialedNumber=&capacity=&desktopLayoutId=&skillProfileId=&multiMediaProfileId=&userIds=,&description=&systemDefault=&queueRankings=[object Object],[object Object]&createdTime=&lastUpdatedTime=", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Precondition Failed" } ] }, { - "name": "Delete specific User Profile by ID", + "name": "Delete specific Team by ID", "request": { - "description": "Delete an existing User Profile by ID in a given organization.", + "description": "Delete an existing Team by ID in a given organization.", "header": [ { "key": "Accept", @@ -102171,10 +104902,10 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102182,7 +104913,7 @@ "value": "" }, { - "description": "Resource ID of the User Profile.", + "description": "Resource ID of the Team.", "key": "id", "value": "" } @@ -102193,7 +104924,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 500, "cookie": [], "header": [ { @@ -102201,7 +104932,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -102217,41 +104948,33 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Operation is forbidden", + "header": [], + "name": "No Content", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -102260,31 +104983,43 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "No Content" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ @@ -102293,26 +105028,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "No Content" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -102320,7 +105057,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -102336,26 +105073,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -102363,7 +105102,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -102379,26 +105118,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -102406,7 +105147,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -102422,26 +105163,28 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -102449,7 +105192,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -102465,28 +105208,30 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/team/:id", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { + "description": "Resource ID of the Team.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" } ] }, { - "name": "List references for a specific User Profile", + "name": "List references for a specific Team", "request": { - "description": "Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing Team by ID in a given organization.", "header": [ { "key": "Accept", @@ -102501,7 +105246,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102522,7 +105267,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102541,7 +105286,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -102549,7 +105294,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -102565,7 +105310,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102586,7 +105331,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102599,12 +105344,12 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -102612,7 +105357,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -102628,7 +105373,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102649,7 +105394,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102662,12 +105407,12 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -102675,7 +105420,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -102691,7 +105436,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102712,7 +105457,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102725,7 +105470,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -102754,7 +105499,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102775,7 +105520,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102793,7 +105538,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -102801,7 +105546,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -102817,7 +105562,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102838,7 +105583,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102851,7 +105596,7 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -102880,7 +105625,7 @@ "path": [ "organization", ":orgid", - "user-profile", + "team", ":id", "incoming-references" ], @@ -102901,7 +105646,7 @@ "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -102919,9 +105664,9 @@ ] }, { - "name": "List User Profile(s)", + "name": "List Team(s)", "request": { - "description": "Retrieve a list of User Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of Team(s) in a given organization.", "header": [ { "key": "Accept", @@ -102937,21 +105682,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -102965,13 +105710,23 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -103010,21 +105765,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103038,15 +105793,26 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -103082,21 +105848,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103110,15 +105876,26 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -103154,21 +105931,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103182,15 +105959,26 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -103199,22 +105987,22 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"cCAf4fef-4A7c4F0d-77Ae-AB5eC2f98C65\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"CAPACITY\",\n \"teamStatus\": \"NOT_AVAILABLE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"3F7eaA0AF76c6AFAAcd9-F0e612Acc8B8\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"e91FfCaC-0Be4-8a6F-6fDf-FE73bc7BbEC9\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"ec42CBd0cfA7-8895bAa6BA94FE9ed09b\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"teamType\": \"AGENT\",\n \"teamStatus\": \"IN_SERVICE\",\n \"dialedNumber\": \"\",\n \"capacity\": \"\",\n \"active\": \"\",\n \"siteId\": \"\",\n \"desktopLayoutId\": \"\",\n \"siteName\": \"\",\n \"skillProfileId\": \"\",\n \"multiMediaProfileId\": \"\",\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"rankQueuesForTeam\": \"\",\n \"queueRankings\": [\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"dc0F7aE7-6392-6eFe2c0bDdf95EAEeD8E\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"queueId\": \"\",\n \"rank\": \"\",\n \"organizationId\": \"A7bcdFcc-52A9-A9D2DECE-5eDe058b09EC\",\n \"id\": \"\",\n \"version\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -103226,21 +106014,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103254,39 +106042,50 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"orgid\": \"4fdBa21C95bD-Ed9F-EcC90857A927e61C\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\u00a0\u2029\",\n \"profileType\": \"ANALYZER_USER\",\n \"organizationId\": \"DD9E43974db0-D62dAA869cBCDBacb9FA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"cEf3EeFFB9024A9A-C9BB-B4A1Ca86a9ca\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"5F61EFcc-fDA8cB9a-afBFd11cCeFCC7dB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"32498CE5-e5F4243419d7cBA0134c24A9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"EEd76bd3-baeAF9eB-aD8A1De114BF93f3\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"f05E2Eb28d82A196C51ceDFbFacBA3eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9eaaf6687ce6-DdCEc736-0dbAa9dACafe\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"ALL\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"c2E9D386-cfC050Ee-41c0-c7dC1a34f8cE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"55c6dBaAE1b06B35Ba19EBa57dEfeCF0\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"ccefc663ce27-52ae-BcBB-38cfd8be6e20\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"dCe555db-48F3-eDceb35b-5d58E3198Af8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"FCb5A309-903Ea2CC7982e5fd6c80F6a0\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E9c22ec2-1cDfa0e4-3fB5-B915aD54AdfC\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"ec535f5dC37BeC4F3b7FdA4CfcA77Df5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -103298,21 +106097,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103326,26 +106125,37 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -103353,7 +106163,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -103370,21 +106180,21 @@ "organization", ":orgid", "v2", - "user-profile" + "team" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", "key": "search", "value": "" }, @@ -103398,28 +106208,44 @@ "key": "pageSize", "value": "100" }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile", + "key": "supervisorView", + "value": "false" + }, + { + "description": "If set to true, the API will only return data that user has access to, according to User Profile.", + "key": "provisioningView", + "value": "false" + }, { "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/team?filter=&attributes=&search=&page=0&pageSize=100&supervisorView=false&provisioningView=false&singleObjectResponse=false", "variable": [ { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" } ] - }, + } + ], + "name": "Team" + }, + { + "item": [ { - "name": "List user profiles", + "name": "List User Profile(s)", "request": { - "description": "Retrieve a list of user profiles in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "description": "Retrieve a list of User Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", @@ -103434,37 +106260,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -103478,7 +106293,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -103486,7 +106301,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -103502,51 +106317,39 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -103554,7 +106357,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -103570,51 +106373,39 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -103622,7 +106413,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -103638,64 +106429,52 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "[\n {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"\ufeff4cVCr\\r\",\n \"profileType\": \"STANDARD_AGENT\",\n \"organizationId\": \"DAb0611175bc-4059E95a16028716cF94\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"25C5A7eF-Ced1eADDCae6Ed6F2ba91c9c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"1AC215B1-adc9-dD0c-DF64EDa4D759ae3d\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4ad3EcfcF811-Ef17f09F-D8F99aC4c918\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"23a1a1Ad-84E522Ed0B9CDD95CCb12468\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"DfbA9cFaA883463BB6ef-c744E7aDe1ed\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"54514925-fDd1-CA0957bBF9aEB59a7E7b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"ALL\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"yf8l7\u2008G60\",\n \"profileType\": \"STANDARD_AGENT\",\n \"organizationId\": \"CbEFEeea5BD5528D88C6-2FBeCD98DeF4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"a70ae62c676a-fdDB5eAB3D68Eee23B4b\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"DBDFF32A8d38-Eefd-2fec-BcEDB3C1F9cd\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"8f9Da531-8edF5c36-06c1581e1CE4CA88\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"Ff8cd03A-AAe1eFB0-C6DF-3b8FEcf198C1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"A7B5A9BC8Ee401026DAB3705Cc4C8aAf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"54b1Fdf06D0E9Cc44fec9FF58bFC0ad9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n }\n]", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -103706,46 +106485,34 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -103774,40 +106541,28 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -103816,22 +106571,22 @@ "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"meta\": {\n \"orgid\": \"E32bdcA756AF-dA45-2bE6-d7b6985BE152\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"m\\n\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"resourceAccessLevel\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"3F2b2b8b-e5af-3Cda-02D2-e00EdAdb14f1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"1\u202fp-G\u2004Y\u200ao\",\n \"organizationId\": \"1AedDaA3-8485-dCF7-1de8-26BA7c84FEf4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"s\",\n \"organizationId\": \"1E85eA0e-E20fc8Bc-CfB8898786ee97aC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"\u00a0\u2000\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_USER\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"1D04DC8c-F8bC-a793B6bCBb36cBE5E38e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"\u2007-hT\",\n \"organizationId\": \"C5DCADA01e631e61-79c4-9F6a04F46fEb\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"SF\",\n \"organizationId\": \"0c3A9d31-914d1DAe-e541176eACbAdeA0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -103842,51 +106597,39 @@ "path": [ "organization", ":orgid", - "v3", "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, { - "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile?filter=&attributes=&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "Create a new User Profile", + "name": "Bulk save User Profile(s)", "request": { "body": { "mode": "raw", @@ -103896,9 +106639,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Create a new user profile in a given organization.", + "description": "Create, Update or delete User Profile(s) in bulk in a given organization.", "header": [ { "key": "Content-Type", @@ -103917,10 +106660,10 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -103934,7 +106677,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -103942,7 +106685,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -103952,7 +106695,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -103972,24 +106715,23 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 429, "cookie": [], "header": [ { @@ -103997,7 +106739,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -104007,7 +106749,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104027,24 +106769,23 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Conflict" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -104052,7 +106793,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -104062,7 +106803,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104082,32 +106823,31 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 201, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Created", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -104117,7 +106857,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104126,7 +106866,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "POST", @@ -104137,32 +106877,31 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Created" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"DELETE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -104172,7 +106911,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104181,7 +106920,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "POST", @@ -104192,24 +106931,23 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -104217,7 +106955,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -104227,7 +106965,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104247,24 +106985,23 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -104272,7 +107009,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -104282,7 +107019,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"E63a7Mf\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"55F18eC8-Dd7b-c6aBFF5ab0aC4cf4FBB3\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"6205980D1Ff363AF-b9f6fbE07A2D2144\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C1BCBDDE7Ede86Bf-bF70-ADEc7EEDE02B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"C40ACC4BaE8E7eb9C7E2ce8349f49C22\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"6501aF31-B2e85aec-EC6aDba2244E3Faf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D2D410E3fBcc-980f-C9FF-cEaB8B44eb3F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4243d969-5F1f7aE0B62F-7dcCDbBbDeaF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"ALL\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\ufeffR\u205fsi\u2007FS\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"7Ca3AAd1-D03EE0658C1c-0FA1EBB274de\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"b5F45Be8-EFca-cFcE-722a-DEedf0b69598\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9b47BCB9D669-6BD2eDA8285b3069B3b4\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"aAFF2B05b3bc6BdFC0DaeBc6BC7ca704\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"3c6E76bC-BAEA-Cb0Defe2-38f6aeAbfF8F\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FBb3Cfdb140F-Fa4bd8C4-03B2DC005B27\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9296cA85-6B7F3C20-ca81-5d5DfdF26f5B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -104302,47 +107039,32 @@ "path": [ "organization", ":orgid", - "v3", - "user-profile" + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] }, { - "name": "Bulk save User Profiles", + "name": "Bulk export User Profiles", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete user profiles in bulk in a given organization.", + "description": "Export all user profiles in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104350,11 +107072,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104366,39 +107099,25 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"b0aBeCE8-f847ad116c39305Ba3b42b3e\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"B64fAB5c-c3ccfc85Bae8-8dcA22E1DDA6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"cbE0254A-2AFE-6549e4f2-7C658592bbb8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"aD80c7e6bb232BC2-F2a0-F1cE5EF5fb5d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"1d5C21bcdFDE-B3bCfB34dB2C56F3DDb5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"61C506A8-aBB1E37c-eeEAda8AE0b0f4ef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"SPECIFIC\",\n \"permissionAccessLevel\": \"NONE\",\n \"resourceAccessLevel\": \"ALL\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4f0BfA41-5DCFe3DF-935B-2a32670bEb72\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"89beDaA8-1FDc-3f7AA9fb8af62EfC11F1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"bCaCbdb3969F02F4-7Fc1-aF5b00CC99cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2eEb19BA2Bd95fc1cd6c-63cFAFd2B63c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f3beA255A12c-76696Fbd-0cb6C9eDcf7E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"48fBC57f-a13C-5Bfc-7fea-06DD6400edef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"accessAllEntryPoints\": \"ALL\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"ALL\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"ALL\",\n \"permissionAccessLevel\": \"ALL\",\n \"resourceAccessLevel\": \"NONE\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104406,11 +107125,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104419,12 +107149,12 @@ ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -104432,29 +107162,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104462,11 +107178,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104475,12 +107202,12 @@ ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -104488,29 +107215,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104518,11 +107231,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104531,12 +107255,12 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -104544,29 +107268,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104574,11 +107284,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104587,12 +107308,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -104600,29 +107321,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104630,67 +107337,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "Multi-Status", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" ], - "path": [ - "organization", - ":orgid", - "v3", - "user-profile", - "bulk" - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104699,12 +107361,12 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -104712,29 +107374,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -104742,11 +107390,22 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104755,21 +107414,21 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" } ] }, { - "name": "Bulk export User Profiles", + "name": "Purge inactive User Profile(s)", "request": { - "description": "Export all user profiles in a given organization.", + "description": "Purge inactive User Profile(s) older than the configured interval for a given organization.", "header": [ { "key": "Accept", "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -104777,23 +107436,17 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -104805,25 +107458,25 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"b0aBeCE8-f847ad116c39305Ba3b42b3e\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"B64fAB5c-c3ccfc85Bae8-8dcA22E1DDA6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"cbE0254A-2AFE-6549e4f2-7C658592bbb8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"aD80c7e6bb232BC2-F2a0-F1cE5EF5fb5d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"1d5C21bcdFDE-B3bCfB34dB2C56F3DDb5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"61C506A8-aBB1E37c-eeEAda8AE0b0f4ef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"SPECIFIC\",\n \"permissionAccessLevel\": \"NONE\",\n \"resourceAccessLevel\": \"ALL\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4f0BfA41-5DCFe3DF-935B-2a32670bEb72\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"89beDaA8-1FDc-3f7AA9fb8af62EfC11F1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"bCaCbdb3969F02F4-7Fc1-aF5b00CC99cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2eEb19BA2Bd95fc1cd6c-63cFAFd2B63c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f3beA255A12c-76696Fbd-0cb6C9eDcf7E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"48fBC57f-a13C-5Bfc-7fea-06DD6400edef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"accessAllEntryPoints\": \"ALL\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"ALL\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"ALL\",\n \"permissionAccessLevel\": \"ALL\",\n \"resourceAccessLevel\": \"NONE\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -104831,37 +107484,30 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -104869,7 +107515,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -104877,7 +107523,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -104885,37 +107531,30 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -104923,7 +107562,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -104931,7 +107570,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -104939,37 +107578,30 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 409, "cookie": [], "header": [ { @@ -104977,7 +107609,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Similar entity is already present", "originalRequest": { "header": [ { @@ -104985,7 +107617,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -104993,32 +107625,25 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -105039,7 +107664,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -105047,26 +107672,19 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] @@ -105077,7 +107695,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -105085,7 +107703,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "header": [ { @@ -105093,7 +107711,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -105101,39 +107719,79 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", - "bulk-export" + "purge-inactive-entities" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", + "variable": [ { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "key": "orgid" } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {},\n \"key_3\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "user-profile", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/purge-inactive-entities?nextStartId=", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "OK" } ] }, { "name": "Get specific User Profile by ID", "request": { - "description": "Retrieve an existing user profile by ID in a given organization.", + "description": "Retrieve an existing User Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -105148,18 +107806,10 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -105176,22 +107826,22 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"Dc\u20009sC\\r\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"BFa5e280-c9EF-9Ce2bB4eEd3dba9EA522\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"234406BAbaeBbbE3-cb52-9Ca4dFA03cDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"bfBEefea5E4E-80BF-D3AcEcAB70DC34eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0387CB15dEeb-2EFA0E3FAe19ad13C3D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"385fce55CdE4A4e4BDeA-f406C29dFfbB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"E4cA0FA2-e232c977-2F9EbEdeC1F3D852\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FFD7357b-e7Af-cC78bF9e-9adb6F2ACCD2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -105202,49 +107852,39 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -105255,36 +107895,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -105292,7 +107922,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -105308,36 +107938,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -105345,7 +107965,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -105361,36 +107981,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -105398,7 +108008,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -105414,36 +108024,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -105451,7 +108051,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -105467,31 +108067,21 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "query": [ - { - "description": "Flag to include resource names in the response.", - "key": "includeNames", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" } ] }, @@ -105506,9 +108096,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "Update an existing user profile by ID in a given organization.", + "description": "Update an existing User Profile by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -105527,11 +108117,10 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -105550,7 +108139,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 412, "cookie": [], "header": [ { @@ -105558,7 +108147,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -105568,7 +108157,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105588,37 +108177,34 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Bad Request" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"ALL\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"Dc\u20009sC\\r\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"BFa5e280-c9EF-9Ce2bB4eEd3dba9EA522\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"234406BAbaeBbbE3-cb52-9Ca4dFA03cDf\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"bfBEefea5E4E-80BF-D3AcEcAB70DC34eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0387CB15dEeb-2EFA0E3FAe19ad13C3D8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"385fce55CdE4A4e4BDeA-f406C29dFfbB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"E4cA0FA2-e232c977-2F9EbEdeC1F3D852\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"FFD7357b-e7Af-cC78bF9e-9adb6F2ACCD2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -105628,7 +108214,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105637,7 +108223,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "PUT", @@ -105648,29 +108234,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -105678,7 +108261,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -105688,7 +108271,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105708,29 +108291,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -105738,7 +108318,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -105748,7 +108328,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105768,29 +108348,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -105798,7 +108375,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -105808,7 +108385,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105828,37 +108405,34 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "OK", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -105868,7 +108442,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105877,7 +108451,7 @@ }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "PUT", @@ -105888,29 +108462,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 401, "cookie": [], "header": [ { @@ -105918,7 +108489,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -105928,7 +108499,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -105948,29 +108519,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -105978,7 +108546,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -105988,7 +108556,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n}" + "raw": "{\n \"accessAllEntryPoints\": \"ALL\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"a\u2009\\rCK\\tO\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"832605EF-7dBC-5ACd-Eb81-528C4De1DC7e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2ad78ddB-6441-BAcA-2a36F4E4aec6CFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"D45eDbc1-82Dc802b-Bd6afF5EDF10a22b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"20A8b3DB-5aaeCD3C-cC2bD8feD18BC77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"D66881f2ecc93cd2dC49-6A7F4E20fdde\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2E626C0cDB44-F65B9A2DFD58286AFfF2\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9886928FcE3BBAAcC1F27E23Ce4a5cD1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\"\n }\n ]\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { @@ -106008,31 +108576,28 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" } ] }, { "name": "Delete specific User Profile by ID", "request": { - "description": "Delete an existing user profile by ID in a given organization.", + "description": "Delete an existing User Profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -106047,11 +108612,10 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -106094,18 +108658,15 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] @@ -106114,14 +108675,24 @@ "status": "Precondition Failed" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "DELETE", "url": { "host": [ @@ -106130,44 +108701,31 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "No Content" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "No Content", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "DELETE", "url": { "host": [ @@ -106176,29 +108734,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "No Content" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -106206,7 +108761,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -106222,29 +108777,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -106252,7 +108804,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -106268,29 +108820,26 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -106298,7 +108847,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -106314,24 +108863,21 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -106360,18 +108906,15 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", "key": "id" } ] @@ -106382,9 +108925,9 @@ ] }, { - "name": "Get specific User Profile ACL by ID", + "name": "List references for a specific User Profile", "request": { - "description": "Retrieve an existing User Profile ACL by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization.", "header": [ { "key": "Accept", @@ -106399,19 +108942,28 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -106419,7 +108971,7 @@ "value": "" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -106430,7 +108982,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -106438,7 +108990,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -106454,91 +109006,46 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," - } - ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" }, { - "description": "Resource ID of the User Profile.", - "key": "id" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": "{\n \"organizationId\": \"5aFadc1Ae76F-D8D6FEB1A8E335fFeFaa\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"description\": \"\",\n \"active\": \"\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"resourceAccessLevel\": \"ALL\",\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"63II-\u00a0T\u2028\",\n \"organizationId\": \"ECdf2343bC60-acaD93c8eF86C8C4024D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"hAZy8IyR7\",\n \"organizationId\": \"2bf8e41d-9c1d23C1-9bd2Eca7BBf6C64a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n }\n ],\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "v3", - "user-profile", - ":id", - "acl" - ], - "query": [ + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -106546,7 +109053,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -106562,37 +109069,46 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -106600,7 +109116,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -106616,37 +109132,46 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -106654,7 +109179,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -106670,32 +109195,41 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -106724,48 +109258,115 @@ "path": [ "organization", ":orgid", - "v3", "user-profile", ":id", - "acl" + "incoming-references" ], "query": [ { - "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", - "key": "names", - "value": "," + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User Profile.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user-profile", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "OK" } ] - } - ], - "name": "User Profiles" - }, - { - "item": [ + }, { - "name": "List User(s)", + "name": "List User Profile(s)", "request": { - "description": "Retrieve a list of User(s) in a given organization.", + "description": "Retrieve a list of User Profile(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -106776,19 +109377,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -106805,7 +109412,7 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -106818,8 +109425,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "[\n {\n \"organizationId\": \"7FE677aD88BB1B48dE71-BAc4cb64A5d3\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"organizationId\": \"DF8C5A4BCbC863bc-0C90d3C3A7f3e5Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"e13feBF2BA7b-ad89AC4f-A7019Ef8A6bB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"98c5EA1eD3DA-1eAe-fAE9ADD2E48346B6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"e8A8cDa7-Ab9f-3AAdd2ed4a32EAbA45bc\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"2dbeC3C0D1eEdf4E-D155-28FDf8864b3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"22181b6d2e17D472cAeC-fA5D2629df6e\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E355de94-9c15-54AB-C8C2-AdeB18BF6c4d\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\\fJ6QAKrfJ\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"PREMIUM_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"8fb0cf4F-3Efd-aCEd-ab6b9A4e7de74E2E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"1\u1680\u1680A\",\n \"organizationId\": \"8afddFdBDaF5fd2D-F4B4-6b735d3F0c85\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"JOO7\",\n \"organizationId\": \"6EB1A825-B3cBbdeE-a31d-4c4ad414ef4a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Cc83049FB72A894C-3F73-C5f569E392af\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"s,Uq\\u000b\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"D83c677E-2a08-e406E8fb924F8e57Df71\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"CAf8Ef9cd87f-d82cAfcE-5893F08ebebc\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4FdD4Ad2-f68D-AcFb-2D08-fD574e30fB9E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9Adf1080-f710a3a0191E-d5eFBbD8DB3a\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"2b950B6e-296e-64eDa29a-4a1BBA9fCc86\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"297c90ce-A95f7002-bCA8-31eF2676cA31\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"f9De6AcD-0aadeEB15fE4-e5e4Bfa9Ad6F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"92s\\f\\frw6\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"BD4b25106B5a9E56-Bc1EDA308Dac84d4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"9\u2008r\",\n \"organizationId\": \"edC07c4E-9F82-B0cdC551-10D119B6a544\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2005\u2002\\nU\u200aJC\",\n \"organizationId\": \"dDdF35e7-6ce4-BccA-5DC35c5d00dCEE26\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n]", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -106827,7 +109434,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -106843,19 +109450,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -106872,21 +109485,20 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -106894,7 +109506,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -106910,19 +109522,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -106939,21 +109557,20 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -106961,7 +109578,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -106977,19 +109594,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -107006,21 +109629,20 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -107028,7 +109650,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -107044,19 +109666,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -107073,21 +109701,92 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" } ] } }, - "status": "Not Found" + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"meta\": {\n \"orgid\": \"4fdBa21C95bD-Ed9F-EcC90857A927e61C\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\u00a0\u2029\",\n \"profileType\": \"ANALYZER_USER\",\n \"organizationId\": \"DD9E43974db0-D62dAA869cBCDBacb9FA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"cEf3EeFFB9024A9A-C9BB-B4A1Ca86a9ca\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"5F61EFcc-fDA8cB9a-afBFd11cCeFCC7dB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"32498CE5-e5F4243419d7cBA0134c24A9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"EEd76bd3-baeAF9eB-aD8A1De114BF93f3\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"f05E2Eb28d82A196C51ceDFbFacBA3eB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"9eaaf6687ce6-DdCEc736-0dbAa9dACafe\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"ALL\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\",\n \"profileType\": \"SUPERVISOR\",\n \"organizationId\": \"c2E9D386-cfC050Ee-41c0-c7dC1a34f8cE\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"55c6dBaAE1b06B35Ba19EBa57dEfeCF0\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"ccefc663ce27-52ae-BcBB-38cfd8be6e20\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"dCe555db-48F3-eDceb35b-5d58E3198Af8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"FCb5A309-903Ea2CC7982e5fd6c80F6a0\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E9c22ec2-1cDfa0e4-3fB5-B915aD54AdfC\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"ec535f5dC37BeC4F3b7FdA4CfcA77Df5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "key": "orgid" + } + ] + } + }, + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -107095,7 +109794,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -107111,19 +109810,25 @@ "path": [ "organization", ":orgid", - "user" + "v2", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -107140,7 +109845,203 @@ "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v2/user-profile?filter=&attributes=&search=&page=0&pageSize=100&singleObjectResponse=false", + "variable": [ + { + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "List user profiles", + "request": { + "description": "Retrieve a list of user profiles in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.", + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107151,6 +110052,74 @@ }, "status": "Internal Server Error" }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -107178,19 +110147,25 @@ "path": [ "organization", ":orgid", - "user" + "v3", + "user-profile" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", "key": "filter", "value": "" }, { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", "key": "attributes", "value": "" }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, { "description": "Defines the number of displayed page. The page number starts from 0.", "key": "page", @@ -107200,14 +110175,77 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107216,12 +110254,80 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": "string", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" } ] }, { - "name": "Bulk partial update Users", + "name": "Create a new User Profile", "request": { "body": { "mode": "raw", @@ -107231,9 +110337,9 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Update some or all properties for multiple users in bulk for a given organization.", + "description": "Create a new user profile in a given organization.", "header": [ { "key": "Content-Type", @@ -107241,10 +110347,10 @@ }, { "key": "Accept", - "value": "application/hal+json" + "value": "*/*" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107252,10 +110358,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107269,7 +110375,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -107277,7 +110383,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -107287,7 +110393,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107299,7 +110405,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107307,10 +110413,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107319,12 +110425,12 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -107332,7 +110438,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { "body": { "mode": "raw", @@ -107342,7 +110448,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107354,7 +110460,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107362,10 +110468,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107374,12 +110480,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -107387,7 +110493,7 @@ "value": "application/json" } ], - "name": "Multi-Status", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -107397,7 +110503,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107406,10 +110512,10 @@ }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107417,10 +110523,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107429,20 +110535,20 @@ ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -107452,7 +110558,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107461,10 +110567,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107472,10 +110578,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107484,12 +110590,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 401, "cookie": [], "header": [ { @@ -107497,7 +110603,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -107507,7 +110613,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107519,7 +110625,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107527,10 +110633,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107539,12 +110645,12 @@ ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 500, "cookie": [], "header": [ { @@ -107552,7 +110658,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -107562,7 +110668,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107574,7 +110680,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107582,10 +110688,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107594,12 +110700,12 @@ ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -107607,7 +110713,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -107617,7 +110723,7 @@ "language": "json" } }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -107629,7 +110735,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107637,10 +110743,10 @@ "path": [ "organization", ":orgid", - "user", - "bulk" + "v3", + "user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107649,21 +110755,35 @@ ] } }, - "status": "Forbidden" + "status": "Too Many Requests" } ] }, { - "name": "Bulk export User(s)", + "name": "Bulk save User Profiles", "request": { - "description": "Export all User(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete user profiles in bulk in a given organization.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107671,22 +110791,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107700,7 +110809,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -107708,15 +110817,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107724,22 +110847,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107748,12 +110860,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"userProfileName\": \"\",\n \"siteName\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"skillProfileName\": \"\",\n \"agentProfileName\": \"\",\n \"multimediaProfileName\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"preferredSupervisorTeam\": \"\"\n },\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"userProfileName\": \"\",\n \"siteName\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"skillProfileName\": \"\",\n \"agentProfileName\": \"\",\n \"multimediaProfileName\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"preferredSupervisorTeam\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], "header": [ { @@ -107761,15 +110873,29 @@ "value": "application/json" } ], - "name": "OK", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107777,22 +110903,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107801,12 +110916,12 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -107814,15 +110929,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107830,22 +110959,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107854,12 +110972,12 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -107867,15 +110985,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107883,22 +111015,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107907,12 +111028,12 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -107920,15 +111041,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107936,22 +111071,67 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" + "v3", + "user-profile", + "bulk" ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", + "variable": [ { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Multi-Status", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "path": [ + "organization", + ":orgid", + "v3", + "user-profile", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -107960,12 +111140,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -107973,15 +111153,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u2003\\f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"664724C1-cbFb7CfadEBe-E8E6d073Ffd5\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"VZ\u2028vj\u1680\",\n \"organizationId\": \"CE9adD0EDAFdDf4b6bA9-6Fa90da3aACF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"Efl\",\n \"organizationId\": \"2F0A5FC6-e24b-Ba06-C6bDba424577c2F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"\u00a0\\n\\r\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"cba44B35Be39-566f-3Ab75abb4dDd6C09\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"YP\u20069q\u2006ji\ufeffnJ\",\n \"organizationId\": \"b8d028f6881d-9005-Be3d-Bf7bff7A88fC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2008eI\",\n \"organizationId\": \"566D64a5-5B5567dC-5Cac96DDfAbfB03B\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ]\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -107989,22 +111183,11 @@ "path": [ "organization", ":orgid", - "user", - "bulk-export" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } + "v3", + "user-profile", + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -108013,18 +111196,18 @@ ] } }, - "status": "Not Found" + "status": "Forbidden" } ] }, { - "name": "Get specific User by CI User ID", + "name": "Bulk export User Profiles", "request": { - "description": "Retrieve an existing User using the CI ID in a given organization.", + "description": "Export all user profiles in a given organization.", "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "*/*" } ], "method": "GET", @@ -108035,50 +111218,50 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "CI ID of the User.", - "key": "id", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"b0aBeCE8-f847ad116c39305Ba3b42b3e\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"B64fAB5c-c3ccfc85Bae8-8dcA22E1DDA6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"cbE0254A-2AFE-6549e4f2-7C658592bbb8\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"aD80c7e6bb232BC2-F2a0-F1cE5EF5fb5d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"1d5C21bcdFDE-B3bCfB34dB2C56F3DDb5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"61C506A8-aBB1E37c-eeEAda8AE0b0f4ef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"SPECIFIC\",\n \"permissionAccessLevel\": \"NONE\",\n \"resourceAccessLevel\": \"ALL\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"moduleOption\": \"NONE\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4f0BfA41-5DCFe3DF-935B-2a32670bEb72\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"89beDaA8-1FDc-3f7AA9fb8af62EfC11F1\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"bCaCbdb3969F02F4-7Fc1-aF5b00CC99cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"2eEb19BA2Bd95fc1cd6c-63cFAFd2B63c\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f3beA255A12c-76696Fbd-0cb6C9eDcf7E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"48fBC57f-a13C-5Bfc-7fea-06DD6400edef\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"accessAllEntryPoints\": \"ALL\",\n \"accessEntryPoints\": [\n \"\",\n \"\"\n ],\n \"accessAllQueues\": \"ALL\",\n \"accessQueues\": [\n \"\",\n \"\"\n ],\n \"accessAllSites\": \"ALL\",\n \"accessSites\": [\n \"\",\n \"\"\n ],\n \"accessAllTeams\": \"ALL\",\n \"permissionAccessLevel\": \"ALL\",\n \"resourceAccessLevel\": \"NONE\",\n \"defaultResourceCollection\": \"\",\n \"resourceCollections\": [\n \"\",\n \"\"\n ],\n \"accessTeams\": [\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n },\n {\n \"siteName\": \"\",\n \"teamName\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -108089,36 +111272,37 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 403, "cookie": [], "header": [ { @@ -108126,7 +111310,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -108142,36 +111326,37 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -108179,7 +111364,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -108195,31 +111380,32 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -108248,26 +111434,27 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } @@ -108301,26 +111488,27 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } @@ -108329,8 +111517,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"f1c3b30C1DA05AD7E93DFA8CAC6D4Fe3\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"ECp\u2007\\u000bKF_7\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"02848F78E47aB15a-FF2A6cDeAa8D7DEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"C5699EFc-e5d34Be2-BFae-BCEC5bf4B227\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"16Dbcb5399ba-9ba5-a6fa51896a7e98AB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0fbDBF340A218AD90e95CbEa3820ed8b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"3ca698D2-55E3668B-6D5d-DE1CB2B3Fba6\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"A8240554-c3E8Ae7c-cCECFeaeF9ef064a\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"6A1cf1dfC4aa888CFA6931A1878DC6AB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -108338,12 +111526,12 @@ "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], "method": "GET", @@ -108354,59 +111542,46 @@ "path": [ "organization", ":orgid", - "user", - "by-ci-user-id", - ":id" + "v3", + "user-profile", + "bulk-export" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" } ] }, { - "name": "Get the agents matching skill requirements criteria", + "name": "Get specific User Profile by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, - "description": "This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request.", + "description": "Retrieve an existing user profile by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/hal+json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108414,32 +111589,28 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id", + "value": "" } ] } @@ -108448,7 +111619,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -108456,29 +111627,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108486,143 +111643,52 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "user", - "fetch-by-skill-requirements" - ], - "query": [ - { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108630,36 +111696,31 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -108674,27 +111735,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108702,31 +111749,26 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } @@ -108735,8 +111777,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgid\": \"E5F69aDc-445f7C114A25-f169ABA9fa86\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"1347ac304F2f-46BfDCF3B84aB05B9c4e\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"skillProfileName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"567bc0AdFDb418E5-E620b2B9e7D89c4C\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"skillProfileName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -108744,29 +111786,15 @@ "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108774,41 +111802,36 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 404, "cookie": [], "header": [ { @@ -108816,29 +111839,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108846,41 +111855,36 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -108888,29 +111892,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"skillRequirements\": [\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1169F2c540aB-ef78D6fD-C31CcDC433F3\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n },\n {\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"1d3d8BAAB8Ba-7CDd5acf-235BaC4bf438\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -108918,41 +111908,36 @@ "path": [ "organization", ":orgid", - "user", - "fetch-by-skill-requirements" + "v3", + "user-profile", + ":id" ], "query": [ { - "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Flag to include resource names in the response.", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id?includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" } ] }, { - "name": "Get specific Users by provided IDs", + "name": "Update specific User Profile by ID", "request": { "body": { "mode": "raw", @@ -108962,9 +111947,9 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - "description": "Retrieve an existing User's first name, last name and email by list of IDs in a given organization.", + "description": "Update an existing user profile by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -108972,10 +111957,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -108983,27 +111968,21 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id", + "value": "" } ] } @@ -109011,8 +111990,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -109020,7 +111999,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -109030,7 +112009,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109042,7 +112021,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109050,36 +112029,29 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "OK" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -109087,7 +112059,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -109097,7 +112069,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109109,7 +112081,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109117,31 +112089,24 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -109164,7 +112129,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109176,7 +112141,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109184,26 +112149,19 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } @@ -109213,7 +112171,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -109221,7 +112179,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -109231,7 +112189,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109243,7 +112201,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109251,36 +112209,29 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -109288,7 +112239,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -109298,7 +112249,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109310,7 +112261,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109318,44 +112269,37 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": "{\n \"active\": \"\",\n \"name\": \"\u2005H\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"5d3D583d-6Fac-c0Eabefe-Ad4c5FEE836D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"yX\u200a95\u205f\",\n \"organizationId\": \"f111CbEB-cD82fB42-C9430b3A28dedBcc\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"E\\t5\u205fTg\u2000g\",\n \"organizationId\": \"3A62FF0fDd35-b5D6badD-Bac7E01DaFC4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -109365,7 +112309,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109374,10 +112318,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109385,36 +112329,29 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "code": 412, "cookie": [], "header": [ { @@ -109422,7 +112359,7 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "body": { "mode": "raw", @@ -109432,7 +112369,7 @@ "language": "json" } }, - "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, "header": [ { @@ -109444,7 +112381,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -109452,45 +112389,98 @@ "path": [ "organization", ":orgid", - "user", - "fetch-user-details-by-ids" - ], - "query": [ - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "10" - } + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Conflict" - } - ] + "status": "Precondition Failed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"H\",\n \"permissionAccessLevel\": \"SPECIFIC\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"ACDDD24A-aF45-08D4C8320bcFc1da7efA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"7_\\t\u2008-F\u180e\u2002\u200a\",\n \"organizationId\": \"d36b0Af6-5fF82588-466DAD346eBa9178\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n },\n {\n \"name\": \"\u2000ZfQ\u2007cs\",\n \"organizationId\": \"F227652D-d0AEcA923FFb-57c94aCa7E92\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + } + ] }, { - "name": "List Users along with profile", + "name": "Delete specific User Profile by ID", "request": { - "description": "Retrieve a list of User(s) along with their UserProfiles in a given organization.", + "description": "Delete an existing user profile by ID in a given organization.", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109498,15 +112488,21 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id", + "value": "" } ] } @@ -109514,8 +112510,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "[\n {\n \"organizationId\": \"7FE677aD88BB1B48dE71-BAc4cb64A5d3\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"\",\n \"profileType\": \"ANALYZER_USER\",\n \"organizationId\": \"DF8C5A4BCbC863bc-0C90d3C3A7f3e5Ee\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"e13feBF2BA7b-ad89AC4f-A7019Ef8A6bB\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"98c5EA1eD3DA-1eAe-fAE9ADD2E48346B6\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"e8A8cDa7-Ab9f-3AAdd2ed4a32EAbA45bc\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"2dbeC3C0D1eEdf4E-D155-28FDf8864b3C\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"22181b6d2e17D472cAeC-fA5D2629df6e\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E355de94-9c15-54AB-C8C2-AdeB18BF6c4d\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\\fJ6QAKrfJ\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"PREMIUM_AGENT\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"8fb0cf4F-3Efd-aCEd-ab6b9A4e7de74E2E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"1\u1680\u1680A\",\n \"organizationId\": \"8afddFdBDaF5fd2D-F4B4-6b735d3F0c85\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"JOO7\",\n \"organizationId\": \"6EB1A825-B3cBbdeE-a31d-4c4ad414ef4a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"Cc83049FB72A894C-3F73-C5f569E392af\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"ALL\",\n \"active\": \"\",\n \"name\": \"s,Uq\\u000b\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"D83c677E-2a08-e406E8fb924F8e57Df71\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"CAf8Ef9cd87f-d82cAfcE-5893F08ebebc\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"4FdD4Ad2-f68D-AcFb-2D08-fD574e30fB9E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"9Adf1080-f710a3a0191E-d5eFBbD8DB3a\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"2b950B6e-296e-64eDa29a-4a1BBA9fCc86\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"297c90ce-A95f7002-bCA8-31eF2676cA31\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"f9De6AcD-0aadeEB15fE4-e5e4Bfa9Ad6F\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"92s\\f\\frw6\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"PROVISIONED_VALUE\",\n \"organizationId\": \"BD4b25106B5a9E56-Bc1EDA308Dac84d4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"9\u2008r\",\n \"organizationId\": \"edC07c4E-9F82-B0cdC551-10D119B6a544\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u2005\u2002\\nU\u200aJC\",\n \"organizationId\": \"dDdF35e7-6ce4-BccA-5DC35c5d00dCEE26\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n]", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, "cookie": [], "header": [ { @@ -109523,7 +112519,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { "header": [ { @@ -109531,7 +112527,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109539,19 +112535,60 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "OK" + "status": "Precondition Failed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v3", + "user-profile", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" + } + ] + } + }, + "status": "No Content" }, { "_postman_previewlanguage": "json", @@ -109572,7 +112609,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109580,14 +112617,19 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } @@ -109597,7 +112639,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -109605,7 +112647,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -109613,7 +112655,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109621,24 +112663,29 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -109646,7 +112693,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -109654,7 +112701,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109662,24 +112709,29 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -109687,7 +112739,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -109695,7 +112747,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109703,19 +112755,24 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -109736,7 +112793,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -109744,14 +112801,19 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile" + "v3", + "user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User Profile.", + "key": "id" } ] } @@ -109761,13 +112823,13 @@ ] }, { - "name": "Get specific User along with profile by ID", + "name": "Get specific User Profile ACL by ID", "request": { - "description": "Retrieve an existing User along with the corresponding UserProfile by ID in a given organization.", + "description": "Retrieve an existing User Profile ACL by ID in a given organization.", "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "*/*" } ], "method": "GET", @@ -109778,11 +112840,19 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -109790,7 +112860,7 @@ "value": "" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id", "value": "" } @@ -109801,7 +112871,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -109809,7 +112879,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -109825,42 +112895,50 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": "{\n \"organizationId\": \"5aFadc1Ae76F-D8D6FEB1A8E335fFeFaa\",\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"description\": \"\",\n \"active\": \"\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"resourceAccessLevel\": \"ALL\",\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"63II-\u00a0T\u2028\",\n \"organizationId\": \"ECdf2343bC60-acaD93c8eF86C8C4024D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"hAZy8IyR7\",\n \"organizationId\": \"2bf8e41d-9c1d23C1-9bd2Eca7BBf6C64a\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n }\n ],\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -109871,29 +112949,37 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -109901,7 +112987,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -109917,29 +113003,37 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 429, "cookie": [], "header": [ { @@ -109947,7 +113041,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -109963,29 +113057,37 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -109993,7 +113095,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -110009,29 +113111,37 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -110039,12 +113149,12 @@ "value": "application/json" } ], - "name": "OK", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], "method": "GET", @@ -110055,35 +113165,48 @@ "path": [ "organization", ":orgid", - "user", - "with-user-profile", - ":id" + "v3", + "user-profile", + ":id", + "acl" ], - "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", + "query": [ + { + "description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n", + "key": "names", + "value": "," + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl?names=,", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "Resource ID of the User.", + "description": "Resource ID of the User Profile.", "key": "id" } ] } }, - "status": "OK" + "status": "Not Found" } ] - }, + } + ], + "name": "User Profiles" + }, + { + "item": [ { - "name": "Get specific User by ID", + "name": "List User(s)", "request": { - "description": "Retrieve an existing Users by ID in a given organization.", + "description": "Retrieve a list of User(s) in a given organization.", "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], "method": "GET", @@ -110094,32 +113217,41 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the User.", - "key": "id", - "value": "" } ] } @@ -110127,8 +113259,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "[\n {\n \"organizationId\": \"F4DdcbEbf85f7271fEbbaBb22ED01a45\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"yq\\n\u2004hFc\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"4fc9e4bfC13bDDBF-2Dc90aB796fb9203\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"BccF47E4-db4A-6c14F974-d1DfCA4C840f\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"aec470df6bC5-49d7dCD6-dC2a52EEBAd9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"364Bd6a7-8cAE2Efa-FddeA1adc695C373\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"bFFdcbdfAa9033Bf-b403-9c2BCF4044c7\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"dCea0F40-0bfc0CCaBd4E27544cb55Fca\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0Ed313E835ac1cB6a33DC1101EC6c2fE\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\u2008 \u2008C\\rIa\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"resourceAccessLevel\": \"SPECIFIC\",\n \"organizationId\": \"e9142Fab-E3aD-F2BE692E-D958E05f52F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"LL77I\u2000-\",\n \"organizationId\": \"3D0D32A4-F57dE33FE7cB-2c7debFCEFcF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"QkI\",\n \"organizationId\": \"D6F6c03e-fDBE-86ECe13aA732c1bee23d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"9eb5bf44-e933A207E1BCef380eB0A702\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"BE43bB99-3A9417bE-Cc4C-Ff1B9D9dDBbC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"052dE1D0E49f-ec3c-1a9B-8e1a9e7055F2\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"qE\u2006m\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"organizationId\": \"e6cFA3e3-a813a6dD-Cd02bcbE3AAce268\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"9FAbCe5baAC9-CEf0b20e865e8c1C392d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"AfD1da9a-B85d-Ff4D-75ae-6FA5BC76cEBD\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"dc118B3E-fE80-Ac9B-7Eb1-C4caD41E7dDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"78C234cD-5Bb7-3cF68F87-1bB67ad10ec1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f75ec2AfdbF6-bb4aA4CEf8cFf48bf3Cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"eF3fD98c6C5E7baFECA2FffCf198c169\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\u00a0NxW\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"SUPERVISOR\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"Af71aAa4-F18cd8Fdfe57C547FD3a6cBC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"XDmn8ufG\",\n \"organizationId\": \"DfbE9f5B-FDB77cb4c65E0cCd47CCfbA1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"hcCtGJ8x\u2004\u2009\",\n \"organizationId\": \"98E2fd9D4FAe-eAA1-Ee0E-7fd0eeA84F73\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"26b6dd46-cc9f-3823fd2c3BbbBA48FD1d\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"89e9DDCb4564-e6be-7D8F-00EBCc4FAdED\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -110136,7 +113268,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { @@ -110152,35 +113284,45 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -110209,30 +113351,40 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } @@ -110266,30 +113418,40 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } @@ -110299,7 +113461,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -110307,7 +113469,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -110323,40 +113485,50 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -110364,7 +113536,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -110380,40 +113552,50 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -110421,12 +113603,12 @@ "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], "method": "GET", @@ -110437,40 +113619,50 @@ "path": [ "organization", ":orgid", - "user", - ":id" + "user" ], "query": [ { - "description": "If `true`, the API response will include the count of each type of Contact Service Queues which are assigned to user.", - "key": "includeCount", - "value": "false" + "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" }, { - "description": "If set to true gives skill profile modification info.", - "key": "includeSkillProfileAudit", + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeSkillProfileAudit=false", + "raw": "{{baseUrl}}/organization/:orgid/user?filter=&attributes=&page=0&pageSize=100&singleObjectResponse=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "OK" + "status": "Forbidden" } ] }, { - "name": "Update specific User by ID", + "name": "Bulk partial update Users", "request": { "body": { "mode": "raw", @@ -110480,9 +113672,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Update an existing User by ID in a given organization.", + "description": "Update some or all properties for multiple users in bulk for a given organization.", "header": [ { "key": "Content-Type", @@ -110493,7 +113685,7 @@ "value": "application/hal+json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110502,87 +113694,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the User.", - "key": "id", - "value": "" } ] } }, "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/hal+json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "user", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -110590,7 +113718,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -110600,7 +113728,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110612,7 +113740,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110621,27 +113749,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 500, "cookie": [], "header": [ { @@ -110649,7 +113773,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -110659,7 +113783,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110671,7 +113795,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110680,27 +113804,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], "header": [ { @@ -110708,7 +113828,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -110718,7 +113838,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110727,10 +113847,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110739,27 +113859,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -110767,7 +113883,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -110777,7 +113893,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110789,7 +113905,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110798,27 +113914,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -110826,7 +113938,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -110836,7 +113948,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110848,7 +113960,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110857,27 +113969,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 400, "cookie": [], "header": [ { @@ -110885,7 +113993,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -110895,7 +114003,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110907,7 +114015,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110916,27 +114024,23 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 403, "cookie": [], "header": [ { @@ -110944,7 +114048,7 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -110954,7 +114058,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"bd9f06582e47CdACa1df7bEAEb3d624e\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"agentProfileId\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"siteId\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"b2Ce18Ff-cDd6ebAdb5FDB33E49fff3b3\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -110966,7 +114070,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -110975,50 +114079,32 @@ "organization", ":orgid", "user", - ":id" + "bulk" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Bad Request" + "status": "Forbidden" } ] }, { - "name": "Partially update User by ID", + "name": "Bulk export User(s)", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, - "description": "Partially update User by ID in a given organization.", + "description": "Export all User(s) in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111027,19 +114113,26 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "Resource ID of the User.", - "key": "id", - "value": "" } ] } @@ -111048,7 +114141,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -111056,29 +114149,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111087,27 +114166,35 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"userProfileName\": \"\",\n \"siteName\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"skillProfileName\": \"\",\n \"agentProfileName\": \"\",\n \"multimediaProfileName\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"preferredSupervisorTeam\": \"\"\n },\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"userProfileName\": \"\",\n \"siteName\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"skillProfileName\": \"\",\n \"agentProfileName\": \"\",\n \"multimediaProfileName\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"preferredSupervisorTeam\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -111115,29 +114202,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111146,27 +114219,35 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -111174,29 +114255,15 @@ "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111205,86 +114272,35 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Resource ID of the User.", - "key": "id" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found or URI is invalid", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "user", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -111292,29 +114308,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111323,27 +114325,35 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -111351,29 +114361,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111382,27 +114378,35 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -111410,29 +114414,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"valueType\": \"NULL\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -111441,33 +114431,41 @@ "organization", ":orgid", "user", - ":id" + "bulk-export" ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/bulk-export?page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "Resource ID of the User.", - "key": "id" } ] } }, - "status": "Bad Request" + "status": "Not Found" } ] }, { - "name": "List references for a specific User", + "name": "Get specific User by CI User ID", "request": { - "description": "Retrieve a list of all entities that have reference to an existing User by ID in a given organization.", + "description": "Retrieve an existing User using the CI ID in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -111479,27 +114477,17 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -111507,7 +114495,7 @@ "value": "" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id", "value": "" } @@ -111518,7 +114506,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -111526,7 +114514,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -111543,45 +114531,35 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -111589,7 +114567,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -111606,45 +114584,35 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -111652,7 +114620,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -111669,45 +114637,35 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -111715,7 +114673,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -111732,45 +114690,35 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -111778,7 +114726,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -111795,45 +114743,35 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "body": "{\n \"organizationId\": \"f1c3b30C1DA05AD7E93DFA8CAC6D4Fe3\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"SPECIFIC\",\n \"accessAllQueues\": \"SPECIFIC\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"ECp\u2007\\u000bKF_7\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"02848F78E47aB15a-FF2A6cDeAa8D7DEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"C5699EFc-e5d34Be2-BFae-BCEC5bf4B227\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"16Dbcb5399ba-9ba5-a6fa51896a7e98AB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0fbDBF340A218AD90e95CbEa3820ed8b\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"3ca698D2-55E3668B-6D5d-DE1CB2B3Fba6\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"A8240554-c3E8Ae7c-cCECFeaeF9ef064a\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"6A1cf1dfC4aa888CFA6931A1878DC6AB\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"DISABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"Eca4Bc1a7C7962ea-EFB7-b75bd55A17e8\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"dFAE43cE3BCCE81fEFeC-5C62Ba70b73a\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -111841,12 +114779,12 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -111858,54 +114796,58 @@ "organization", ":orgid", "user", - ":id", - "incoming-references" + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" - }, - { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id?includeUserProfile=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of this contact center resource.", + "description": "CI ID of the User.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "OK" } ] }, { - "name": "List User(s)", + "name": "Get the agents matching skill requirements criteria", "request": { - "description": "Retrieve a list of User(s) in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/hal+json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -111913,20 +114855,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -111941,34 +114873,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -111982,7 +114889,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -111990,15 +114897,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112006,20 +114927,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112034,34 +114945,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112070,12 +114956,12 @@ ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgid\": \"Dd8B96FE-5bf7-fc24-B6EfD916A327ED32\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"3B0e4934afa1440Ca40f-edDBa6AcDaf0\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"4j\u2003\u205fm9\u2006\u200ab\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"cbe8BFD817c1bdA8B72E-D27c8Ca75818\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"377ACB6e-1fcddd2B2F9F-b15FfA6c8098\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2ead9Bf99Ab7Eaf6-Fe6b1d9d1efF7731\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"cd4cC8c6-911644cbaa5ecF9E70D19CA5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"ff49Ca2f-6d6B0f4f9D9E013bC5bEaFFD\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"C7F1BC6c-DD9c-7af2dB03cC22B3e0C60B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"e63DC494Bb917b66-3eDB0bcbea0F3DdF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"L9b_s\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"SPECIFIC\",\n \"organizationId\": \"9d22E2CfE581CFBb98467A15f45Dee6A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"\u180e4\u20037OW\\f4\",\n \"organizationId\": \"dcf94CcA-eC7b9ecDd64E-B2EDa8dDf37e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"XQ\\t\u2004\",\n \"organizationId\": \"0C8f0E7CDefC-9AEb79A5-aDBb00bafb3f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"0Cd6fCaAe034-D5c942D8e637FB32c7f2\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"SPECIFIC\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\u2028\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"D10a3cc8-B986-1bF8cf0B126abb11BFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4fFc9abE6cdf55c8aDd96B8d6Fd70F39\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"BE175a77-E2f7-Ef0ba0B5-cbAcC3aF76CF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"b1B761FF6CD3a48404dc-3BAa4E5DD77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"fA5d7FD9-c499-2c26e099-8f929a9A885D\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0dCE315F-2e602aDbbdea-0ED01B99CaB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"Dbe412ae-B1E9-ff29-E37E8C67Ec47bB1f\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"d4\u2000b4Lc9i\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"b82C1515-AC93f4b7-F50EF9D9D61112Fe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"my\u2006mnbjO\",\n \"organizationId\": \"a4d2bF14cBcf1a8fFd8480c6e28ffa1D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u1680E\\u000bIaTb6Y\\f\",\n \"organizationId\": \"f29B7E0b-7ff9-1E19-DaFE38F5f11Ab162\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -112083,15 +114969,29 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112099,20 +114999,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112127,34 +115017,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112163,12 +115028,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 400, "cookie": [], "header": [ { @@ -112176,15 +115041,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112192,20 +115071,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112220,34 +115089,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112256,7 +115100,7 @@ ] } }, - "status": "Too Many Requests" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -112271,13 +115115,27 @@ ], "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112285,20 +115143,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112313,34 +115161,81 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", + "variable": [ { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgid\": \"E5F69aDc-445f7C114A25-f169ABA9fa86\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {}\n },\n \"data\": [\n {\n \"organizationId\": \"1347ac304F2f-46BfDCF3B84aB05B9c4e\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"skillProfileName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"567bc0AdFDb418E5-E620b2B9e7D89c4C\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"skillProfileName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/hal+json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "fetch-by-skill-requirements" + ], + "query": [ { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", + "value": "" }, { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112349,12 +115244,12 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 409, "cookie": [], "header": [ { @@ -112362,15 +115257,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Similar entity is already present", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112378,20 +115287,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112406,34 +115305,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112442,7 +115316,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -112457,13 +115331,27 @@ ], "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"condition\": \"\",\n \"skillId\": \"\",\n \"skillValue\": \"\",\n \"organizationId\": \"F5DC1c7D-0F15-65E6-c0F6-5d8E1572fe35\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillName\": \"\",\n \"skillType\": \"\",\n \"weight\": \"\",\n \"dynamicSkill\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112471,20 +115359,10 @@ "path": [ "organization", ":orgid", - "v2", - "user" + "user", + "fetch-by-skill-requirements" ], "query": [ - { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, { "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", "key": "search", @@ -112499,34 +115377,9 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - }, - { - "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", - "key": "supervisorManagedAgentsOnly", - "value": "false" - }, - { - "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", - "key": "singleObjectResponse", - "value": "false" - }, - { - "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", - "key": "buddyTeamAgentsOnly", - "value": "false" - }, - { - "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", - "key": "userInQueue", - "value": "" - }, - { - "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", - "key": "queueId", - "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements?search=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -112540,16 +115393,30 @@ ] }, { - "name": "Get specific User by CI User ID", + "name": "Fetch User details by IDs", "request": { - "description": "Retrieve an existing User using the CI ID in a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, + "description": "Retrieve an existing User's first name, last name and email by list of IDs in a given organization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112557,34 +115424,27 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "CI ID of the User.", - "key": "id", - "value": "" } ] } @@ -112592,8 +115452,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -112601,15 +115461,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112617,42 +115491,36 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -112660,15 +115528,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112676,42 +115558,36 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -112719,15 +115595,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112735,42 +115625,36 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"027a57BDD4E0eAD75B4f4e0C66bbebfC\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"32DA8e3b3aF5-9d6BF59c-c9eB0C9CcEBf\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"m4\u3000FKU\",\n \"organizationId\": \"CCb3B9be365A-Fed4-690E-dFddcCC3CFe1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"WRj\u205f\u200a\u2009i\u2028\\t\\nF\",\n \"organizationId\": \"E3C29Af0-DDCEc2FF25e9-6CFd84B3a6ab\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], "header": [ { @@ -112778,15 +115662,29 @@ "value": "application/json" } ], - "name": "OK", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112794,37 +115692,31 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "OK" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -112839,13 +115731,27 @@ ], "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112853,32 +115759,26 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } @@ -112888,7 +115788,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -112896,15 +115796,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -112912,90 +115826,32 @@ "path": [ "organization", ":orgid", - "v2", "user", - "by-ci-user-id", - ":id" + "fetch-user-details-by-ids" ], "query": [ { - "description": "Specifiy whether to include user profile data", - "key": "includeUserProfile", - "value": "" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Specifiy whether to include resource collection names", - "key": "includeNames", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "CI ID of the User.", - "key": "id" } ] } }, - "status": "Forbidden" - } - ] - } - ], - "name": "Users" - }, - { - "item": [ - { - "name": "Create a new Work Type", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "status": "Bad Request" }, - "description": "Create a new Work Type in a given organization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type" - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -113017,7 +115873,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"userIds\": [\n \"\",\n \"\"\n ],\n \"search\": \"\",\n \"queueId\": \"\"\n}" }, "header": [ { @@ -113037,9 +115893,22 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "fetch-user-details-by-ids" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "10" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids?page=0&pageSize=10", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113049,11 +115918,45 @@ } }, "status": "Conflict" - }, + } + ] + }, + { + "name": "List Users along with profile", + "request": { + "description": "Retrieve a list of User(s) along with their UserProfiles in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "with-user-profile" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "[\n {\n \"organizationId\": \"F4DdcbEbf85f7271fEbbaBb22ED01a45\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"PROVISIONED_VALUE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"yq\\n\u2004hFc\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"4fc9e4bfC13bDDBF-2Dc90aB796fb9203\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"BccF47E4-db4A-6c14F974-d1DfCA4C840f\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"aec470df6bC5-49d7dCD6-dC2a52EEBAd9\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"364Bd6a7-8cAE2Efa-FddeA1adc695C373\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"bFFdcbdfAa9033Bf-b403-9c2BCF4044c7\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"dCea0F40-0bfc0CCaBd4E27544cb55Fca\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"0Ed313E835ac1cB6a33DC1101EC6c2fE\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\u2008 \u2008C\\rIa\",\n \"permissionAccessLevel\": \"PROVISIONED_VALUE\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"resourceAccessLevel\": \"SPECIFIC\",\n \"organizationId\": \"e9142Fab-E3aD-F2BE692E-D958E05f52F6\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"LL77I\u2000-\",\n \"organizationId\": \"3D0D32A4-F57dE33FE7cB-2c7debFCEFcF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"QkI\",\n \"organizationId\": \"D6F6c03e-fDBE-86ECe13aA732c1bee23d\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"9eb5bf44-e933A207E1BCef380eB0A702\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"BE43bB99-3A9417bE-Cc4C-Ff1B9D9dDBbC\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"052dE1D0E49f-ec3c-1a9B-8e1a9e7055F2\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"SPECIFIC\",\n \"active\": \"\",\n \"name\": \"qE\u2006m\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"organizationId\": \"e6cFA3e3-a813a6dD-Cd02bcbE3AAce268\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"9FAbCe5baAC9-CEf0b20e865e8c1C392d\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"AfD1da9a-B85d-Ff4D-75ae-6FA5BC76cEBD\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"dc118B3E-fE80-Ac9B-7Eb1-C4caD41E7dDC\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"78C234cD-5Bb7-3cF68F87-1bB67ad10ec1\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"f75ec2AfdbF6-bb4aA4CEf8cFf48bf3Cf\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"eF3fD98c6C5E7baFECA2FffCf198c169\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\u00a0NxW\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"SUPERVISOR\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"Af71aAa4-F18cd8Fdfe57C547FD3a6cBC\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"XDmn8ufG\",\n \"organizationId\": \"DfbE9f5B-FDB77cb4c65E0cCd47CCfbA1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"hcCtGJ8x\u2004\u2009\",\n \"organizationId\": \"98E2fd9D4FAe-eAA1-Ee0E-7fd0eeA84F73\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"26b6dd46-cc9f-3823fd2c3BbbBA48FD1d\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"89e9DDCb4564-e6be-7D8F-00EBCc4FAdED\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -113061,29 +115964,15 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113091,9 +115980,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113102,12 +115992,12 @@ ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -113115,29 +116005,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113145,9 +116021,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113156,12 +116033,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 429, "cookie": [], "header": [ { @@ -113169,29 +116046,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113199,9 +116062,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113210,12 +116074,12 @@ ] } }, - "status": "Bad Request" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -113223,29 +116087,15 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113253,9 +116103,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113264,12 +116115,12 @@ ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -113277,29 +116128,15 @@ "value": "application/json" } ], - "name": "OK", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113307,9 +116144,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113318,12 +116156,12 @@ ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -113331,29 +116169,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113361,9 +116185,10 @@ "path": [ "organization", ":orgid", - "work-type" + "user", + "with-user-profile" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -113372,35 +116197,21 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" } ] }, { - "name": "Bulk save Work Type(s)", + "name": "Get specific User along with profile by ID", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "description": "Create, Update or delete Work Type(s) in bulk in a given organization.", + "description": "Retrieve an existing User along with the corresponding UserProfile by ID in a given organization.", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113408,15 +116219,21 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" } ] } @@ -113425,7 +116242,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 403, "cookie": [], "header": [ { @@ -113433,29 +116250,15 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Operation is forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113463,79 +116266,29 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - } - ] - } - }, - "status": "Too Many Requests" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "bulk" - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", - "variable": [ + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -113543,29 +116296,15 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113573,24 +116312,29 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 500, "cookie": [], "header": [ { @@ -113598,29 +116342,15 @@ "value": "application/json" } ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113628,19 +116358,24 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -113655,27 +116390,13 @@ ], "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113683,14 +116404,19 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } @@ -113699,8 +116425,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", - "code": 207, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], "header": [ { @@ -113708,29 +116434,15 @@ "value": "application/json" } ], - "name": "Multi-Status", + "name": "Resource not found or URI is invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113738,24 +116450,29 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Multi-Status (WebDAV) (RFC 4918)" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"e61384EFce80-5aFBEb41-3Dbacce6dcaE\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e96Bf265-1De6A6bbB9ebc2268EEaFADf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -113763,29 +116480,15 @@ "value": "application/json" } ], - "name": "Similar entity is already present", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -113793,30 +116496,35 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk" + "user", + "with-user-profile", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "raw": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Conflict" + "status": "OK" } ] }, { - "name": "Bulk export Work Type(s)", + "name": "Get specific User by ID", "request": { - "description": "Export all Work Type(s) in a given organization.", + "description": "Retrieve an existing Users by ID in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -113827,27 +116535,47 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" } ] } @@ -113855,8 +116583,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"workTypeCode\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"workTypeCode\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -113864,7 +116592,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -113880,36 +116608,55 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -113917,7 +116664,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -113933,31 +116680,50 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", @@ -113986,26 +116752,45 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } @@ -114015,7 +116800,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -114023,7 +116808,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -114039,36 +116824,55 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -114076,7 +116880,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -114092,36 +116896,55 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"e61384EFce80-5aFBEb41-3Dbacce6dcaE\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e96Bf265-1De6A6bbB9ebc2268EEaFADf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -114129,12 +116952,12 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "OK", "originalRequest": { "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -114145,45 +116968,78 @@ "path": [ "organization", ":orgid", - "work-type", - "bulk-export" + "user", + ":id" ], "query": [ { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to", + "key": "includeCount", + "value": "false" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "50" + "description": "If set to true, the API response will include the user profile", + "key": "includeUserProfileType", + "value": "false" + }, + { + "description": "If set to true gives skill profile modification info.", + "key": "includeSkillProfileAudit", + "value": "false" + }, + { + "description": "If set to true gives skill profile and dynamic skill modification info.", + "key": "includeReskillAuditInfo", + "value": "false" + }, + { + "description": "If set to true,the response includes skill information for each dynamic skill assignment", + "key": "includeSkillDetails", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "raw": "{{baseUrl}}/organization/:orgid/user/:id?includeCount=false&includeUserProfileType=false&includeSkillProfileAudit=false&includeReskillAuditInfo=false&includeSkillDetails=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "OK" } ] }, { - "name": "Purge inactive Work Type(s)", + "name": "Update specific User by ID", "request": { - "description": "Purge inactive Work Type(s) older than the configured interval for a given organization.", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Update an existing User by ID in a given organization.", "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/hal+json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114191,22 +117047,20 @@ "path": [ "organization", ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "user", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" } ] } @@ -114214,8 +117068,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"e61384EFce80-5aFBEb41-3Dbacce6dcaE\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e96Bf265-1De6A6bbB9ebc2268EEaFADf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -114223,63 +117077,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Similar entity is already present", - "originalRequest": { - "header": [ + }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114287,79 +117107,28 @@ "path": [ "organization", ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "user", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - } - ] - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "The request was invalid and cannot be served. An accompanying error message will explain further", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", - "variable": [ + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 429, "cookie": [], "header": [ { @@ -114367,111 +117136,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114479,31 +117166,28 @@ "path": [ "organization", ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } + "user", + ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "Resource ID of the User.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 412, "cookie": [], "header": [ { @@ -114511,102 +117195,29 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - "purge-inactive-entities" - ], - "query": [ - { - "description": "This is the entity ID from which items for the next purge batch with be selected.", - "key": "nextStartId", - "value": "" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Get specific Work Type by ID", - "request": { - "description": "Retrieve an existing Work Type by ID in a given organization.", - "header": [ - { - "key": "Accept", - "value": "application/hal+json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid", - "value": "" + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" }, - { - "description": "ID of the work_type.", - "key": "id", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", - "originalRequest": { "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114614,28 +117225,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "json", - "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -114643,15 +117254,29 @@ "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", - "value": "application/hal+json" + "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114659,28 +117284,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 403, "cookie": [], "header": [ { @@ -114688,15 +117313,29 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Operation is forbidden", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114704,28 +117343,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -114733,15 +117372,29 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114749,28 +117402,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -114778,15 +117431,29 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114794,28 +117461,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -114823,15 +117490,29 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"ciUserId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"userProfileId\": \"\",\n \"organizationId\": \"4A79a48bFCdD010e-a7b4c333f4e0f3f6\",\n \"id\": \"\",\n \"version\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"siteId\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"0b943fb6FbE17FA1ebabaEC0F0d1BB3B\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"888B755Bfb70CF6A-44ED3e2742DF68bf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -114839,28 +117520,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] }, { - "name": "Update specific Work Type by ID", + "name": "Partially update User by ID", "request": { "body": { "mode": "raw", @@ -114870,9 +117551,9 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, - "description": "Update an existing Work Type by ID in a given organization.", + "description": "Partially update User by ID in a given organization.", "header": [ { "key": "Content-Type", @@ -114880,10 +117561,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -114891,10 +117572,10 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -114902,7 +117583,7 @@ "value": "" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id", "value": "" } @@ -114913,7 +117594,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -114921,7 +117602,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -114931,7 +117612,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -114943,7 +117624,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -114951,28 +117632,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -114980,7 +117661,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -114990,7 +117671,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115002,7 +117683,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115010,27 +117691,27 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "body": "{\n \"organizationId\": \"abF81E0C0460-c02C-1B92-0b137aD4E93d\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"SPECIFIC\",\n \"accessAllModules\": \"PROVISIONED_VALUE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"NONE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"yZ\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"organizationId\": \"D8A8E7Ec1D4D-BEBb-6D7da7B9DB9E1fAF\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"b913C65A-bB16d16f-64310cc03e65feab\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"076FBE3D-bc803AfB8Cf68CebDcE05AC7\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"F2d64aDD598B-d91a-cCc1-9c7De9E7bD08\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"1E9B16ecB33e-D653beE4B5aCFabf4fc4\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"a2D72AA8-0f9b-1698-5B713313A5aa0d23\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"E7f87FDb7DcA-C2c7-Ccfc-1e14b7d0BB63\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"s0g\u205f\",\n \"permissionAccessLevel\": \"ALL\",\n \"profileType\": \"ANALYZER_SUPERVISOR\",\n \"resourceAccessLevel\": \"ALL\",\n \"organizationId\": \"878BaeaB8ccD4D51-Ee6314dad1Fad2DB\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"r36fs\\t\u2007\u3000pD\u1680\",\n \"organizationId\": \"b2e0Cb91c2c9-A73f-4822-CCf72A3e3fFd\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"c5e2XZp\ufeffy \",\n \"organizationId\": \"Eed94Ebb42B9-Cf9a-fcCf-2Ec9E1c9DA6E\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"EXCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"e61384EFce80-5aFBEb41-3Dbacce6dcaE\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"e96Bf265-1De6A6bbB9ebc2268EEaFADf\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -115049,7 +117730,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115058,10 +117739,10 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115069,17 +117750,17 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] @@ -115090,7 +117771,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -115098,7 +117779,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -115108,7 +117789,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115120,7 +117801,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115128,28 +117809,28 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -115157,7 +117838,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -115167,7 +117848,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115179,7 +117860,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115187,23 +117868,23 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", @@ -115226,7 +117907,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115238,7 +117919,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115246,17 +117927,17 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] @@ -115264,65 +117945,6 @@ }, "status": "Forbidden" }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - ":id" - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", - "variable": [ - { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" - }, - { - "description": "ID of the work_type.", - "key": "id" - } - ] - } - }, - "status": "Precondition Failed" - }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", @@ -115344,7 +117966,7 @@ "language": "json" } }, - "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + "raw": "{\n \"valueType\": \"NULL\"\n}" }, "header": [ { @@ -115356,7 +117978,7 @@ "value": "application/json" } ], - "method": "PUT", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -115364,17 +117986,17 @@ "path": [ "organization", ":orgid", - "work-type", + "user", ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "Resource ID of the User.", "key": "id" } ] @@ -115385,16 +118007,16 @@ ] }, { - "name": "Delete specific Work Type by ID", + "name": "List references for a specific User", "request": { - "description": "Delete an existing Work Type by ID in a given organization.", + "description": "Retrieve a list of all entities that have reference to an existing User by ID in a given organization.", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115402,10 +118024,28 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", @@ -115413,7 +118053,7 @@ "value": "" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id", "value": "" } @@ -115424,7 +118064,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -115432,7 +118072,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -115440,7 +118080,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115448,28 +118088,46 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -115477,7 +118135,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -115485,7 +118143,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115493,28 +118151,46 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 404, "cookie": [], "header": [ { @@ -115522,7 +118198,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -115530,7 +118206,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115538,23 +118214,41 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -115575,7 +118269,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115583,63 +118277,46 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", - "variable": [ + "query": [ { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" }, { - "description": "ID of the work_type.", - "key": "id" + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 200, - "cookie": [], - "header": [], - "name": "OK", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "organization", - ":orgid", - "work-type", - ":id" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -115647,7 +118324,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "OK", "originalRequest": { "header": [ { @@ -115655,7 +118332,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115663,28 +118340,46 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 412, + "code": 429, "cookie": [], "header": [ { @@ -115692,7 +118387,7 @@ "value": "application/json" } ], - "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -115700,7 +118395,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -115708,30 +118403,48 @@ "path": [ "organization", ":orgid", - "work-type", - ":id" + "user", + ":id", + "incoming-references" ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references?type=&page=0&pageSize=100", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" }, { - "description": "ID of the work_type.", + "description": "ID of this contact center resource.", "key": "id" } ] } }, - "status": "Precondition Failed" + "status": "Too Many Requests" } ] }, { - "name": "List references for a specific Work Type", + "name": "List User(s)", "request": { - "description": "Retrieve a list of all entities that have reference to an existing Work Type by ID in a given organization.", + "description": "Retrieve a list of User(s) in a given organization.", "header": [ { "key": "Accept", @@ -115746,14 +118459,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -115765,19 +118487,49 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" - }, - { - "description": "ID of this contact center resource.", - "key": "id", - "value": "" } ] } @@ -115786,7 +118538,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 404, "cookie": [], "header": [ { @@ -115794,7 +118546,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -115810,14 +118562,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -115829,35 +118590,66 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" - } - ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", - "variable": [ + }, { - "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", - "key": "orgid" + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" }, { - "description": "ID of this contact center resource.", - "key": "id" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgid\": \"Dd8B96FE-5bf7-fc24-B6EfD916A327ED32\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"actualBurnoutInclusionCount\": \"\",\n \"actualAutoCSATCount\": \"\",\n \"actualSummariesCount\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"3B0e4934afa1440Ca40f-edDBa6AcDaf0\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"PROVISIONED_VALUE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"PROVISIONED_VALUE\",\n \"accessAllTeams\": \"PROVISIONED_VALUE\",\n \"active\": \"\",\n \"name\": \"4j\u2003\u205fm9\u2006\u200ab\",\n \"profileType\": \"ADMINISTRATOR\",\n \"organizationId\": \"cbe8BFD817c1bdA8B72E-D27c8Ca75818\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"377ACB6e-1fcddd2B2F9F-b15FfA6c8098\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"2ead9Bf99Ab7Eaf6-Fe6b1d9d1efF7731\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"cd4cC8c6-911644cbaa5ecF9E70D19CA5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"NONE\",\n \"organizationId\": \"ff49Ca2f-6d6B0f4f9D9E013bC5bEaFFD\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"C7F1BC6c-DD9c-7af2dB03cC22B3e0C60B\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"e63DC494Bb917b66-3eDB0bcbea0F3DdF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"L9b_s\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"STANDARD_AGENT\",\n \"resourceAccessLevel\": \"SPECIFIC\",\n \"organizationId\": \"9d22E2CfE581CFBb98467A15f45Dee6A\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"ENABLED\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"\u180e4\u20037OW\\f4\",\n \"organizationId\": \"dcf94CcA-eC7b9ecDd64E-B2EDa8dDf37e\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"XQ\\t\u2004\",\n \"organizationId\": \"0C8f0E7CDefC-9AEb79A5-aDBb00bafb3f\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"0Cd6fCaAe034-D5c942D8e637FB32c7f2\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileData\": {\n \"accessAllEntryPoints\": \"NONE\",\n \"accessAllModules\": \"NONE\",\n \"accessAllQueues\": \"NONE\",\n \"accessAllSites\": \"SPECIFIC\",\n \"accessAllTeams\": \"NONE\",\n \"active\": \"\",\n \"name\": \"\u2028\",\n \"profileType\": \"ANALYZER_ADMINISTRATOR\",\n \"organizationId\": \"D10a3cc8-B986-1bF8cf0B126abb11BFbA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"userProfileAppModules\": [\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"EDIT\",\n \"organizationId\": \"4fFc9abE6cdf55c8aDd96B8d6Fd70F39\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"OFF\",\n \"organizationId\": \"BE175a77-E2f7-Ef0ba0B5-cbAcC3aF76CF\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"b1B761FF6CD3a48404dc-3BAa4E5DD77E\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appModuleId\": \"\",\n \"moduleAccessType\": \"VIEW\",\n \"organizationId\": \"fA5d7FD9-c499-2c26e099-8f929a9A885D\",\n \"id\": \"\",\n \"version\": \"\",\n \"userProfileAppFeature\": [\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"0dCE315F-2e602aDbbdea-0ED01B99CaB5\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"appFeatureId\": \"\",\n \"featureAccessType\": \"ON\",\n \"organizationId\": \"Dbe412ae-B1E9-ff29-E37E8C67Ec47bB1f\",\n \"id\": \"\",\n \"version\": \"\",\n \"appFeatureName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"entryPoints\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"queues\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ]\n },\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"d4\u2000b4Lc9i\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR_ONLY\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"b82C1515-AC93f4b7-F50EF9D9D61112Fe\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"DISABLED\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"EDIT\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"my\u2006mnbjO\",\n \"organizationId\": \"a4d2bF14cBcf1a8fFd8480c6e28ffa1D\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"PROVISIONED_VALUE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"\u1680E\\u000bIaTb6Y\\f\",\n \"organizationId\": \"f29B7E0b-7ff9-1E19-DaFE38F5f11Ab162\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"NONE\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"INCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"INCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "header": [ { @@ -115873,14 +118665,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -115892,27 +118693,58 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -115920,7 +118752,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -115936,14 +118768,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -115955,27 +118796,58 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -115983,7 +118855,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -115999,14 +118871,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -116018,27 +118899,58 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -116046,7 +118958,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -116062,14 +118974,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -116081,27 +119002,58 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -116109,7 +119061,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -116125,14 +119077,23 @@ "path": [ "organization", ":orgid", - "work-type", - ":id", - "incoming-references" + "v2", + "user" ], "query": [ { - "description": "Entity type of the other entity that has a reference to this specific entity.", - "key": "type", + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported.", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n", + "key": "search", "value": "" }, { @@ -116144,33 +119105,64 @@ "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "pageSize", "value": "100" + }, + { + "description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.", + "key": "supervisorManagedAgentsOnly", + "value": "false" + }, + { + "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.", + "key": "singleObjectResponse", + "value": "false" + }, + { + "description": "If set to true, returns only users who are part of buddy teams without PBAC check.", + "key": "buddyTeamAgentsOnly", + "value": "false" + }, + { + "description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.", + "key": "userInQueue", + "value": "" + }, + { + "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched.", + "key": "queueId", + "value": "" + }, + { + "description": "If set to true, the API response will include the count of each AI features mapped to the entity.", + "key": "includeAIMappingCount", + "value": "false" + }, + { + "description": "If true, includes whether each user has reached the dynamic skills assignment limit.", + "key": "includeDynamicSkillsLimitReached", + "value": "false" } ], - "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user?filter=&attributes=&search=&page=0&pageSize=100&supervisorManagedAgentsOnly=false&singleObjectResponse=false&buddyTeamAgentsOnly=false&userInQueue=&queueId=&includeAIMappingCount=false&includeDynamicSkillsLimitReached=false", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" - }, - { - "description": "ID of this contact center resource.", - "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] }, { - "name": "List Work Type(s)", + "name": "Get specific User by CI User ID", "request": { - "description": "Retrieve a list of Work Type(s) in a given organization.", + "description": "Retrieve an existing User using the CI ID in a given organization.", "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -116182,41 +119174,33 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid", "value": "" + }, + { + "description": "CI ID of the User.", + "key": "id", + "value": "" } ] } @@ -116225,7 +119209,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 429, + "code": 401, "cookie": [], "header": [ { @@ -116233,7 +119217,7 @@ "value": "application/json" } ], - "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -116250,50 +119234,41 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -116301,7 +119276,7 @@ "value": "application/json" } ], - "name": "Resource not found or URI is invalid", + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "header": [ { @@ -116318,50 +119293,41 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 404, "cookie": [], "header": [ { @@ -116369,7 +119335,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Resource not found or URI is invalid", "originalRequest": { "header": [ { @@ -116386,49 +119352,40 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } }, - "status": "Unauthorized" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"key_0\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"f1abFfdc-6eae-C24CCb1e9eD75B3DdAf2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"SNk\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"38a6516EB1de-ebBf-fa4E69FfEbCEC3cA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "body": "{\n \"organizationId\": \"027a57BDD4E0eAD75B4f4e0C66bbebfC\",\n \"id\": \"\",\n \"version\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"workPhone\": \"\",\n \"mobile\": \"\",\n \"ciUserId\": \"\",\n \"broadCloudUserId\": \"\",\n \"timezone\": \"\",\n \"xspVersion\": \"\",\n \"subscriptionId\": \"\",\n \"userProfileId\": \"\",\n \"userProfileType\": \"\",\n \"contactCenterEnabled\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"teamIds\": [\n \"\",\n \"\"\n ],\n \"skillProfileId\": \"\",\n \"agentProfileId\": \"\",\n \"multimediaProfileId\": \"\",\n \"deafultDialledNumber\": \"\",\n \"externalIdentifier\": \"\",\n \"active\": \"\",\n \"dbId\": \"\",\n \"userProfileGranularAccessData\": {\n \"active\": \"\",\n \"name\": \"\",\n \"permissionAccessLevel\": \"NONE\",\n \"profileType\": \"ADMINISTRATOR\",\n \"resourceAccessLevel\": \"NONE\",\n \"organizationId\": \"32DA8e3b3aF5-9d6BF59c-c9eB0C9CcEBf\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"access\": \"VIEW\"\n }\n ],\n \"editableFolderIds\": [\n \"\",\n \"\"\n ],\n \"viewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"nonViewableFolderIds\": [\n \"\",\n \"\"\n ],\n \"systemDefault\": \"\",\n \"defaultResourceCollectionId\": \"\",\n \"resourceCollections\": [\n {\n \"name\": \"m4\u3000FKU\",\n \"organizationId\": \"CCb3B9be365A-Fed4-690E-dFddcCC3CFe1\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"ALL\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"name\": \"WRj\u205f\u200a\u2009i\u2028\\t\\nF\",\n \"organizationId\": \"E3C29Af0-DDCEc2FF25e9-6CFd84B3a6ab\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"resources\": [\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"accessLevel\": \"SPECIFIC\",\n \"name\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resourceCount\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"imiUserCreated\": \"\",\n \"preferredSupervisorTeamId\": \"\",\n \"systemDefault\": \"\",\n \"userLevelBurnoutInclusion\": \"INCLUDED\",\n \"userLevelAutoCSATInclusion\": \"EXCLUDED\",\n \"userLevelWellnessBreakReminders\": \"ENABLED\",\n \"userLevelSummariesInclusion\": \"EXCLUDED\",\n \"queuesCount\": {\n \"teamBased\": \"\",\n \"skillBased\": \"\",\n \"agentBased\": \"\"\n },\n \"skillProfileUpdatedBy\": \"\",\n \"dynamicSkills\": [\n {\n \"skillId\": \"\",\n \"organizationId\": \"df186eaF72f0B1ADd73dBC2AFba89AD5\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"skillId\": \"\",\n \"organizationId\": \"93076A6cfFcf-E4bD9eF96dE3Ce4Aea5a\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"dynamicSkillsLimitReached\": \"\",\n \"dynamicSkillsUpdatedBy\": \"\",\n \"dynamicSkillsUpdatedTime\": \"\",\n \"dynamicSkillAssigned\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"skillProfileUpdatedTime\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -116442,7 +119399,7 @@ "header": [ { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], "method": "GET", @@ -116454,40 +119411,31 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } @@ -116497,7 +119445,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 500, "cookie": [], "header": [ { @@ -116505,7 +119453,7 @@ "value": "application/json" } ], - "name": "Operation is forbidden", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -116522,50 +119470,41 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -116573,7 +119512,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Operation is forbidden", "originalRequest": { "header": [ { @@ -116590,55 +119529,41 @@ "organization", ":orgid", "v2", - "work-type" + "user", + "by-ci-user-id", + ":id" ], "query": [ { - "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", - "key": "filter", - "value": "" - }, - { - "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", - "key": "attributes", - "value": "" - }, - { - "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", - "key": "search", - "value": "" - }, - { - "description": "Defines the number of displayed page. The page number starts from 0.", - "key": "page", - "value": "0" + "description": "Specifiy whether to include user profile data", + "key": "includeUserProfile", + "value": "" }, { - "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", - "key": "pageSize", - "value": "100" + "description": "Specifiy whether to include resource collection names", + "key": "includeNames", + "value": "" } ], - "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "raw": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id?includeUserProfile=&includeNames=", "variable": [ { "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", "key": "orgid" + }, + { + "description": "CI ID of the User.", + "key": "id" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] - } - ], - "name": "Work Types" - }, - { - "item": [ + }, { - "name": "Register a Data Source", + "name": "Bulk update User dynamic skills", "request": { "body": { "mode": "raw", @@ -116648,9 +119573,9 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, - "description": "Register your data source to the Webex BYODS system. Authentication must happen via a Service App with the scope `spark-admin:datasource_write`.\nThe schema IDs determine what data types are sent from Webex to the DAP and the expected responses. The schemas can be inspected on developer.webex.com.", + "description": "Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization.", "header": [ { "key": "Content-Type", @@ -116658,28 +119583,50 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/hal+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], - "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -116689,71 +119636,60 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources" - ], - "raw": "{{baseUrl}}/dataSources" - } - }, - "status": "Gateway Timeout" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, - "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -116763,71 +119699,60 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources" - ], - "raw": "{{baseUrl}}/dataSources" - } - }, - "status": "Gone" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, - "cookie": [], - "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"DELETE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, "cookie": [], - "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Multi-Status", "originalRequest": { "body": { "mode": "raw", @@ -116837,34 +119762,60 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/hal+json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "Unsupported Media Type" + "status": "Multi-Status (WebDAV) (RFC 4918)" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", "originalRequest": { "body": { "mode": "raw", @@ -116874,71 +119825,60 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources" - ], - "raw": "{{baseUrl}}/dataSources" - } - }, - "status": "Method Not Allowed" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, - "cookie": [], - "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "Bad Gateway" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { "body": { "mode": "raw", @@ -116948,31 +119888,52 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "Precondition Required" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -116980,7 +119941,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", "originalRequest": { "body": { "mode": "raw", @@ -116990,7 +119951,7 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { @@ -117002,26 +119963,48 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "OK" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", "originalRequest": { "body": { "mode": "raw", @@ -117031,34 +120014,5089 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"eE6a4bCb6e01CAFb-5Be0FDE6dBf3D03E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"organizationId\": \"890ACb05-679F-52A0BfEaA1b19aD0Ef3E\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources" + "organization", + ":orgid", + "user", + "bulk", + "update-dynamic-skill", + ":skillId" ], - "raw": "{{baseUrl}}/dataSources" + "raw": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The unique identifier of the skill.", + "key": "skillId", + "value": "" + } + ] } }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, - "cookie": [], - "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "status": "Not Found" + } + ] + }, + { + "name": "Get users by dynamic skill ID", + "request": { + "description": "Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value.", + "header": [ + { + "key": "Accept", + "value": "application/hal+json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"key_0\": 1425,\n \"key_1\": 5789.42795309622\n },\n \"data\": [\n {\n \"organizationId\": \"9D8afb0E-2bC88c865a2bFf9477EB2beC\",\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"dynamicSkill\": {\n \"skillId\": \"\",\n \"organizationId\": \"2eAc25620fC7CDBE-B523-3204C1f01E8c\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n },\n {\n \"organizationId\": \"E6d5cD24Bf0426C0-c4dE-ee1ce57B3eff\",\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"dynamicSkill\": {\n \"skillId\": \"\",\n \"organizationId\": \"a57fBDdc-f6F8-E9bE-17Bb-6FB458aaB6cD\",\n \"id\": \"\",\n \"version\": \"\",\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"enumSkillValues\": \"\",\n \"skillName\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/hal+json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + "by-dynamic-skill-id", + ":skillId" + ], + "query": [ + { + "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId?search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "The dynamic skill ID to fetch users for", + "key": "skillId", + "value": "" + } + ] + } + }, + "status": "OK" + } + ] + }, + { + "name": "Reskill Agents", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "description": "Reskill agents by assigning or unassigning skills.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"organizationId\": \"dF9adc9D54AA41c9780a-B9bC3b0eCfE7\",\n \"id\": \"\",\n \"version\": \"\",\n \"skillProfileId\": \"\",\n \"dynamicSkills\": {\n \"add\": [\n {\n \"organizationId\": \"Dda93Fed-Ac13-fbeE-3473Aaa0Fa1b03eE\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"organizationId\": \"bbdcF98Bcd1ee3fAA23De1De4C34dAEA\",\n \"id\": \"\",\n \"version\": \"\",\n \"userId\": \"\",\n \"enumSkillValues\": [\n \"\",\n \"\"\n ],\n \"textValue\": \"\",\n \"booleanValue\": \"\",\n \"proficiencyValue\": \"\",\n \"skillId\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ],\n \"remove\": [\n \"\",\n \"\"\n ]\n },\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "user", + ":id", + "reskill" + ], + "raw": "{{baseUrl}}/organization/:orgid/user/:id/reskill", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "Resource ID of the User.", + "key": "id", + "value": "" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + } + ], + "name": "Users" + }, + { + "item": [ + { + "name": "Create a new Work Type", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Create a new Work Type in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Similar entity is already present", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Bulk save Work Type(s)", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "description": "Create, Update or delete Work Type(s) in bulk in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"UPDATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n },\n {\n \"itemIdentifier\": \"\",\n \"status\": \"\",\n \"operationType\": \"CREATE\",\n \"href\": \"\",\n \"apiError\": {\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", + "code": 207, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Multi-Status", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Multi-Status (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Similar entity is already present", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"items\": [\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"rOU\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"a3f34091-ABb1bC17B3B621963AA8F956\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n },\n {\n \"itemIdentifier\": \"\",\n \"item\": {\n \"active\": \"\",\n \"name\": \"9iYf\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"B8a6dc3d-c2A1b1D873FcE7c3bc15fBB0\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n },\n \"requestAction\": \"\"\n }\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Conflict" + } + ] + }, + { + "name": "Bulk export Work Type(s)", + "request": { + "description": "Export all Work Type(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"totalResources\": \"\",\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"rel\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"workTypeCode\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"workTypeCode\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "bulk-export" + ], + "query": [ + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "50" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/bulk-export?page=0&pageSize=50", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" + } + ] + }, + { + "name": "Purge inactive Work Type(s)", + "request": { + "description": "Purge inactive Work Type(s) older than the configured interval for a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Similar entity is already present", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"code\": \"\",\n \"details\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"links\": [\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n },\n {\n \"href\": \"\",\n \"hreflang\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"deprecation\": \"\",\n \"profile\": \"\",\n \"name\": \"\",\n \"templated\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + "purge-inactive-entities" + ], + "query": [ + { + "description": "This is the entity ID from which items for the next purge batch with be selected.", + "key": "nextStartId", + "value": "" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities?nextStartId=", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + } + ] + }, + { + "name": "Get specific Work Type by ID", + "request": { + "description": "Retrieve an existing Work Type by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/hal+json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of the work_type.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/hal+json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Update specific Work Type by ID", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "description": "Update an existing Work Type by ID in a given organization.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of the work_type.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"active\": \"\",\n \"name\": \"Cv\u2002\u2008\u2003.\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"aCaDFEDC-5aF9-55DcBCdCD6C42c8E0A1b\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Precondition Failed" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request was invalid and cannot be served. An accompanying error message will explain further", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"active\": \"\",\n \"name\": \"VVuI\u2005\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"adAdB5F5b38e-CEc1B2AFBFf7fdB99EB4\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Bad Request" + } + ] + }, + { + "name": "Delete specific Work Type by ID", + "request": { + "description": "Delete an existing Work Type by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of the work_type.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 200, + "cookie": [], + "header": [], + "name": "OK", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 412, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id" + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of the work_type.", + "key": "id" + } + ] + } + }, + "status": "Precondition Failed" + } + ] + }, + { + "name": "List references for a specific Work Type", + "request": { + "description": "Retrieve a list of all entities that have reference to an existing Work Type by ID in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + }, + { + "description": "ID of this contact center resource.", + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"description\": \"\",\n \"meta\": {\n \"orgid\": \"55aD5F2a-ACD09EFa8BbB2E58679B1D6F\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\",\n \"totalRecords\": \"\",\n \"links\": {},\n \"referencedEntities\": [\n \"\",\n \"\"\n ],\n \"currentEntity\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"version\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "work-type", + ":id", + "incoming-references" + ], + "query": [ + { + "description": "Entity type of the other entity that has a reference to this specific entity.", + "key": "type", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references?type=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + }, + { + "description": "ID of this contact center resource.", + "key": "id" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "List Work Type(s)", + "request": { + "description": "Retrieve a list of Work Type(s) in a given organization.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found or URI is invalid", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"data\": [\n {\n \"active\": \"\",\n \"name\": \"\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"f1abFfdc-6eae-C24CCb1e9eD75B3DdAf2\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n },\n {\n \"active\": \"\",\n \"name\": \"SNk\",\n \"workTypeCode\": \"\",\n \"organizationId\": \"38a6516EB1de-ebBf-fa4E69FfEbCEC3cA\",\n \"id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"systemDefault\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Operation is forbidden", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "organization", + ":orgid", + "v2", + "work-type" + ], + "query": [ + { + "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n", + "key": "filter", + "value": "" + }, + { + "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported", + "key": "attributes", + "value": "" + }, + { + "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n", + "key": "search", + "value": "" + }, + { + "description": "Defines the number of displayed page. The page number starts from 0.", + "key": "page", + "value": "0" + }, + { + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "pageSize", + "value": "100" + } + ], + "raw": "{{baseUrl}}/organization/:orgid/v2/work-type?filter=&attributes=&search=&page=0&pageSize=100", + "variable": [ + { + "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.", + "key": "orgid" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + } + ], + "name": "Work Types" + }, + { + "item": [ + { + "name": "Register a Data Source", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "description": "Register your data source to the Webex BYODS system. Authentication must happen via a Service App with the scope `spark-admin:datasource_write`.\nThe schema IDs determine what data types are sent from Webex to the DAP and the expected responses. The schemas can be inspected on developer.webex.com.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources" + ], + "raw": "{{baseUrl}}/dataSources" + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "body": { "mode": "raw", @@ -118015,60 +126053,1074 @@ "raw": "{{baseUrl}}/dataSources/schemas" } }, - "status": "Gone" + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas" + ], + "raw": "{{baseUrl}}/dataSources/schemas" + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas" + ], + "raw": "{{baseUrl}}/dataSources/schemas" + } + }, + "status": "Precondition Required" + } + ] + }, + { + "name": "Retrieve Details of a Specific Data Source Schema", + "request": { + "description": "Retrieve details of a specific data source schema by schema id. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 504, + "cookie": [], + "header": [], + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Gateway Timeout" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"appType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"protocol\": \"\",\n \"serviceType\": \"\",\n \"url\": \"\"\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 423, + "cookie": [], + "header": [], + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Locked (WebDAV) (RFC 4918)" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + "schemas", + ":schemaId" + ], + "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "variable": [ + { + "description": "The unique identifier for the schema.", + "key": "schemaId" + } + ] + } + }, + "status": "Service Unavailable" + } + ] + }, + { + "name": "Delete a Data Source", + "request": { + "description": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.", + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 405, + "cookie": [], + "header": [], + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Method Not Allowed" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 429, + "cookie": [], + "header": [], + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 502, + "cookie": [], + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Bad Gateway" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 409, + "cookie": [], + "header": [], + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 204, + "cookie": [], + "header": [], + "name": "No Content", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "No Content" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 410, + "cookie": [], + "header": [], + "name": "Gone: The requested resource is no longer available.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Gone" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 415, + "cookie": [], + "header": [], + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Unsupported Media Type" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 428, + "cookie": [], + "header": [], + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Precondition Required" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "dataSources", + ":dataSourceId" + ], + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] + } + }, + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 423, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "dataSources", - "schemas" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas" + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] } }, - "status": "Gateway Timeout" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 504, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "dataSources", - "schemas" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas" + "raw": "{{baseUrl}}/dataSources/:dataSourceId", + "variable": [ + { + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" + } + ] } }, - "status": "Precondition Required" + "status": "Gateway Timeout" } ] }, { - "name": "Retrieve Details of a Specific Data Source Schema", + "name": "Retrieve Data Source Details", "request": { - "description": "Retrieve details of a specific data source schema by schema id. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.", + "description": "Show details for a data source, by dataSource id.\nTo see details for a data source, use the Service App token with the `spark-admin:datasource_read` scope.", "header": [ { "key": "Accept", @@ -118082,14 +127134,13 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId", + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId", "value": "" } ] @@ -118099,10 +127150,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { "header": [], "method": "GET", @@ -118112,27 +127163,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 409, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { "header": [], "method": "GET", @@ -118142,27 +127192,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 500, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { "header": [], "method": "GET", @@ -118172,27 +127221,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 400, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { "header": [], "method": "GET", @@ -118202,27 +127250,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Gateway Timeout" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 428, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { "header": [], "method": "GET", @@ -118232,27 +127279,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Unauthorized" + "status": "Precondition Required" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 405, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -118262,27 +127308,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Unsupported Media Type" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 503, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { "header": [], "method": "GET", @@ -118292,27 +127337,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Precondition Required" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 415, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { "header": [], "method": "GET", @@ -118322,27 +127366,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Conflict" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 429, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { "header": [], "method": "GET", @@ -118352,39 +127395,28 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"appType\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"protocol\": \"\",\n \"serviceType\": \"\",\n \"url\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 502, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -118392,27 +127424,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "OK" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 403, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { "header": [], "method": "GET", @@ -118422,27 +127453,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 504, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { "header": [], "method": "GET", @@ -118452,27 +127482,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Gateway Timeout" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 423, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { "header": [], "method": "GET", @@ -118482,27 +127511,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Gone" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 404, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { "header": [], "method": "GET", @@ -118512,29 +127540,38 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Method Not Allowed" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -118542,27 +127579,26 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 410, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { "header": [], "method": "GET", @@ -118572,28 +127608,46 @@ ], "path": [ "dataSources", - "schemas", - ":schemaId" + ":dataSourceId" ], - "raw": "{{baseUrl}}/dataSources/schemas/:schemaId", + "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the schema.", - "key": "schemaId" + "description": "The unique identifier for the dataSource.", + "key": "dataSourceId" } ] } }, - "status": "Service Unavailable" + "status": "Gone" } ] }, { - "name": "Delete a Data Source", + "name": "Update a Data Source", "request": { - "description": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.", - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "description": "Updates a Data Source. The updateable fields are the `audience,` `subject,` `nonce,` `url` and `tokenLifetimeMinutes.`\nYou can update the `status` from `active` to `disabled` only when providing an `errorMessage` that may be shown to the customer admin in Control Hub. \nTokens must be regularly updated before their expiration to maintain system uptime.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118605,7 +127659,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId", "value": "" } @@ -118616,13 +127670,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 502, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118634,24 +127703,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Forbidden" + "status": "Bad Gateway" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 410, "cookie": [], "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "name": "Gone: The requested resource is no longer available.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118663,24 +127747,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Not Found" + "status": "Gone" }, { "_postman_previewlanguage": "text", "body": null, - "code": 405, + "code": 400, "cookie": [], "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118692,24 +127791,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 415, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118721,24 +127835,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Too Many Requests" + "status": "Unsupported Media Type" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 429, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118750,24 +127879,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Bad Gateway" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 423, "cookie": [], "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118779,24 +127923,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Service Unavailable" + "status": "Locked (WebDAV) (RFC 4918)" }, { "_postman_previewlanguage": "text", "body": null, - "code": 409, + "code": 403, "cookie": [], "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118808,13 +127967,13 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -118824,8 +127983,23 @@ "header": [], "name": "Unauthorized: Authentication credentials were missing or incorrect.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118837,7 +128011,7 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] @@ -118848,13 +128022,28 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 404, "cookie": [], "header": [], - "name": "No Content", + "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118866,24 +128055,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "No Content" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 410, + "code": 504, "cookie": [], "header": [], - "name": "Gone: The requested resource is no longer available.", + "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118895,24 +128099,48 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Gone" + "status": "Gateway Timeout" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, + "_postman_previewlanguage": "json", + "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118924,24 +128152,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 503, "cookie": [], "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "name": "Service Unavailable: Server is overloaded with requests. Try again later.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118953,24 +128196,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 428, + "code": 500, "cookie": [], "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -118982,24 +128240,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 409, "cookie": [], "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -119011,24 +128284,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Internal Server Error" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 405, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -119040,24 +128328,39 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Method Not Allowed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 504, + "code": 428, "cookie": [], "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -119069,21 +128372,31 @@ "raw": "{{baseUrl}}/dataSources/:dataSourceId", "variable": [ { - "description": "The unique identifier for the dataSource.", + "description": "The unique identifier for the data source.", "key": "dataSourceId" } ] } }, - "status": "Gateway Timeout" + "status": "Precondition Required" } ] - }, + } + ], + "name": "Data Sources" + }, + { + "item": [ { - "name": "Retrieve Data Source Details", + "name": "Get Estimated Wait Time", "request": { - "description": "Show details for a data source, by dataSource id.\nTo see details for a data source, use the Service App token with the `spark-admin:datasource_read` scope.", + "description": "Retrieve Estimated Wait Time information for a specified look back interval for a specific orgId and queueId combination, with ability to customomize maxCV and minValidSamples (See description above).\n", "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Accept", "value": "application/json" @@ -119095,309 +128408,574 @@ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId", + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 401, "cookie": [], - "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources", - ":dataSourceId" - ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "*/*" } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + ], + "name": "Forbidden", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "*/*" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 400, "cookie": [], - "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation Error", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, - "status": "Precondition Required" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"estimatedWaitTime\": \"\"\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "ewt" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Id of the queue for which the EWT is to be returned", + "key": "queueId", + "value": "" + }, + { + "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", + "key": "lookbackMinutes", + "value": "" + }, + { + "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", + "key": "maxCV", + "value": "" + }, + { + "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", + "key": "minValidSamples", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" } }, - "status": "Method Not Allowed" + "status": "OK" + } + ] + } + ], + "name": "Estimated Wait Time" + }, + { + "item": [ + { + "name": "Subscribe Notification", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, + "description": "Access this endpoint when the user has to register for a WebSocket Session. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin', 'cloud-contact-center:pod_conv' for authorization", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "notification", + "subscribe" + ], + "raw": "{{baseUrl}}/v1/notification/subscribe" + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"webSocketUrl\": \"\",\n \"subscriptionId\": {\n \"description\": \"Id used by client to subscribe to interested events.\",\n \"example\": \"AgentDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391\",\n \"format\": \"uuid\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "notification", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/notification/subscribe" } }, - "status": "Service Unavailable" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 415, + "code": 503, "cookie": [], "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", + "name": "Service Unavailable", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "notification", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/notification/subscribe" } }, - "status": "Unsupported Media Type" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "notification", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/notification/subscribe" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 502, + "code": 500, "cookie": [], "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", + "name": "Internal Server Error", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "notification", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/notification/subscribe" } }, - "status": "Bad Gateway" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -119405,119 +128983,308 @@ "code": 403, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Forbidden Request", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "notification", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/notification/subscribe" } }, "status": "Forbidden" - }, + } + ] + } + ], + "name": "Notification" + }, + { + "item": [ + { + "name": "Get Queue Statistics", + "request": { + "description": "Retrieve Queue statistics for a given interval of time. \nAn important thing to note is that each stat produced is for a specified time window (last 15, 30, or 60 minutes etc) and is not cumulative. \nContacts that span across intervals will also have stats broken down across intervals. For example: A contact that starts at 12:05 and ends at 12:25 will have stats for Interval A (12:00-12:15) and Interval B (12:15-12:30) assuming the interval window is for 15 minutes. \nStats that only require the start time of the contact like 'totalOfferedTasks' and 'totalAcceptedTasks' will be counted only once and it will be present in the interval where the contact started i.e. Interval A. \nWhereas, stats that require the end time as well for calculations like 'averageHandledTime', will be present in the interval where the contact ended i.e. interval B. \n\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients. \n", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "queues", + "statistics" + ], + "query": [ + { + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&queueIds=&orgId=" + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], - "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "queues", + "statistics" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" } }, - "status": "Gateway Timeout" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 423, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation Error", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "queues", + "statistics" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Forbidden", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "*/*" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "queues", + "statistics" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" } }, - "status": "Not Found" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", + "body": "{\n \"data\": [\n {\n \"intervalStartTime\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"channelType\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalEnqueuedTasks\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalAbandonedTasks\": \"\",\n \"averageEnqueuedTime\": \"\",\n \"averageHandledTime\": \"\",\n \"serviceLevelThresholdPercentage\": \"\"\n },\n {\n \"intervalStartTime\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"channelType\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalEnqueuedTasks\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalAbandonedTasks\": \"\",\n \"averageEnqueuedTime\": \"\",\n \"averageHandledTime\": \"\",\n \"serviceLevelThresholdPercentage\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -119529,6 +129296,11 @@ "name": "OK", "originalRequest": { "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Accept", "value": "application/json" @@ -119540,53 +129312,117 @@ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "queues", + "statistics" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" } }, "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "queues", + "statistics" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the dataSource.", - "key": "dataSourceId" + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", + "key": "queueIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" } }, - "status": "Gone" + "status": "Internal Server Error" } ] - }, + } + ], + "name": "Queues" + }, + { + "item": [ { - "name": "Update a Data Source", + "name": "Subscribe Realtime Notification", "request": { "body": { "mode": "raw", @@ -119596,9 +129432,9 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, - "description": "Updates a Data Source. The updateable fields are the `audience,` `subject,` `nonce,` `url` and `tokenLifetimeMinutes.`\nYou can update the `status` from `active` to `disabled` only when providing an `errorMessage` that may be shown to the customer admin in Control Hub. \nTokens must be regularly updated before their expiration to maintain system uptime.", + "description": "Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'atlas-portal.partner.helpdesk', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin' for authorization", "header": [ { "key": "Content-Type", @@ -119609,121 +129445,32 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId", - "value": "" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 502, - "cookie": [], - "header": [], - "name": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources", - ":dataSourceId" - ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] - } - }, - "status": "Bad Gateway" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 410, + "_postman_previewlanguage": "json", + "body": "{\n \"webSocketUrl\": \"\",\n \"subscriptionId\": {\n \"description\": \"Id used by client to subscribe to interested events.\",\n \"example\": \"ExtensiveSupervisoryDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391\",\n \"format\": \"uuid\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Gone: The requested resource is no longer available.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources", - ":dataSourceId" - ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Gone" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, - "cookie": [], - "header": [], - "name": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.", + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -119733,85 +129480,40 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "dataSources", - ":dataSourceId" - ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 415, - "cookie": [], - "header": [], - "name": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, - "status": "Unsupported Media Type" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 429, + "code": 401, "cookie": [], "header": [], - "name": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -119821,7 +129523,7 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, "header": [ { @@ -119829,33 +129531,28 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, - "status": "Too Many Requests" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 423, + "code": 503, "cookie": [], "header": [], - "name": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -119865,7 +129562,7 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, "header": [ { @@ -119873,33 +129570,28 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, - "status": "Locked (WebDAV) (RFC 4918)" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden: The request is understood, but it has been refused or access is not allowed.", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -119909,7 +129601,7 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, "header": [ { @@ -119917,33 +129609,28 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized: Authentication credentials were missing or incorrect.", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -119953,7 +129640,7 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" }, "header": [ { @@ -119961,33 +129648,88 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "v1", + "realtime", + "subscribe" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ - { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" - } - ] + "raw": "{{baseUrl}}/v1/realtime/subscribe" } }, - "status": "Unauthorized" + "status": "Forbidden" + } + ] + } + ], + "name": "Realtime" + }, + { + "item": [ + { + "name": "Search tasks", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, + "description": "The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n- **Required Roles:** Administrator or Supervisor\n\nMandatory parameters are FROM and TO, which accept datetime in epoch format. The FROM parameter cannot be older than 36 months from the current time. The TO parameter, if given as a future time, will be set to the current time. Optional parameters such as filter and aggregation are accepted for each query.\n\nResponse Compression: For this API, response compression using gzip can be enabled by including the 'Accept-Encoding' header in the request with its value as 'gzip'. The response will be compressed only if its size exceeds 1 MB. If the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma-separated encodings), then the API response will not be compressed, impacting latency as observed from clients.", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "search" + ], + "query": [ + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/search?orgId=" + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "", + "code": 200, "cookie": [], - "header": [], - "name": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -119997,41 +129739,55 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 504, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Not Found", "originalRequest": { "body": { "mode": "raw", @@ -120041,38 +129797,47 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Gateway Timeout" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"id\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -120080,7 +129845,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -120090,9 +129855,14 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -120102,33 +129872,38 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Service Unavailable: Server is overloaded with requests. Try again later.", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Conflict", "originalRequest": { "body": { "mode": "raw", @@ -120138,41 +129913,55 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", @@ -120182,41 +129971,55 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "*/*" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -120226,41 +130029,55 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 405, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation Error", "originalRequest": { "body": { "mode": "raw", @@ -120270,41 +130087,55 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Method Not Allowed" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 428, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 413, "cookie": [], - "header": [], - "name": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Content Too Large", "originalRequest": { "body": { "mode": "raw", @@ -120314,48 +130145,57 @@ "language": "json" } }, - "raw": "{\n \"audience\": \"\",\n \"errorMessage\": \"\",\n \"nonce\": \"\",\n \"schemaId\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"tokenLifetimeMinutes\": \"\",\n \"url\": \"\"\n}" + "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "dataSources", - ":dataSourceId" + "search" ], - "raw": "{{baseUrl}}/dataSources/:dataSourceId", - "variable": [ + "query": [ { - "description": "The unique identifier for the data source.", - "key": "dataSourceId" + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/search?orgId=" } }, - "status": "Precondition Required" + "status": "Request Entity Too Large" } ] } ], - "name": "Data Sources" + "name": "Search" }, { "item": [ { - "name": "Get Estimated Wait Time", + "name": "List Subscriptions", "request": { - "description": "Retrieve Estimated Wait Time information for a specified look back interval for a specific orgId and queueId combination, with ability to customomize maxCV and minValidSamples (See description above).\n", + "description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V1 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.", "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -120371,43 +130211,23 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -120415,11 +130235,11 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -120435,62 +130255,42 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Forbidden", + "name": "Forbidden Operation", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], "method": "GET", @@ -120500,44 +130300,24 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -120545,11 +130325,11 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -120565,44 +130345,24 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -120610,11 +130370,11 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Validation Error", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -120630,43 +130390,23 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"estimatedWaitTime\": \"\"\n}", + "body": "{\n \"data\": [\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n },\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -120679,7 +130419,7 @@ "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -120695,49 +130435,24 @@ ], "path": [ "v1", - "ewt" + "subscriptions" ], "query": [ { - "description": "Id of the queue for which the EWT is to be returned", - "key": "queueId", - "value": "" - }, - { - "description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue", - "key": "lookbackMinutes", - "value": "" - }, - { - "description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %", - "key": "maxCV", - "value": "" - }, - { - "description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %", - "key": "minValidSamples", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/ewt?queueId=&lookbackMinutes=&maxCV=&minValidSamples=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions?orgId=" } }, "status": "OK" } ] - } - ], - "name": "Estimated Wait Time" - }, - { - "item": [ + }, { - "name": "Subscribe Notification", + "name": "Register Subscription", "request": { "body": { "mode": "raw", @@ -120747,10 +130462,15 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, - "description": "Access this endpoint when the user has to register for a WebSocket Session. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin', 'cloud-contact-center:pod_conv' for authorization", + "description": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope.", "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -120767,17 +130487,16 @@ ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"webSocketUrl\": \"\",\n \"subscriptionId\": {\n \"description\": \"Id used by client to subscribe to interested events.\",\n \"example\": \"AgentDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391\",\n \"format\": \"uuid\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -120785,7 +130504,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Validation Error", "originalRequest": { "body": { "mode": "raw", @@ -120795,9 +130514,14 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -120814,21 +130538,25 @@ ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions" } }, - "status": "OK" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -120838,12 +130566,73 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + }, + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions" + ], + "raw": "{{baseUrl}}/v1/subscriptions" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", + "code": 201, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Created", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -120853,21 +130642,77 @@ ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions" } }, - "status": "Service Unavailable" + "status": "Created" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden Operation", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + }, + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions" + ], + "raw": "{{baseUrl}}/v1/subscriptions" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 401, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -120877,12 +130722,21 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -120892,106 +130746,321 @@ ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions" + ], + "raw": "{{baseUrl}}/v1/subscriptions" + } + }, + "status": "Unauthorized" + } + ] + }, + { + "name": "Get Subscription", + "request": { + "description": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope.", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions", + ":id" + ], + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id", + "value": "" + } + ] + } + }, + "response": [ + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Validation Error", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions", + ":id" + ], + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden Operation", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions", + ":id" + ], + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "Unauthorized" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" - }, "header": [ { - "key": "Content-Type", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], - "header": [], - "name": "Forbidden Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"isKeepAliveEnabled\": false,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" - }, "header": [ { - "key": "Content-Type", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "notification", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/notification/subscribe" + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "Forbidden" + "status": "Unauthorized" } ] - } - ], - "name": "Notification" - }, - { - "item": [ + }, { - "name": "Get Queue Statistics", + "name": "Delete Subscription", "request": { - "description": "Retrieve Queue statistics for a given interval of time. \nAn important thing to note is that each stat produced is for a specified time window (last 15, 30, or 60 minutes etc) and is not cumulative. \nContacts that span across intervals will also have stats broken down across intervals. For example: A contact that starts at 12:05 and ends at 12:25 will have stats for Interval A (12:00-12:15) and Interval B (12:15-12:30) assuming the interval window is for 15 minutes. \nStats that only require the start time of the contact like 'totalOfferedTasks' and 'totalAcceptedTasks' will be counted only once and it will be present in the interval where the contact started i.e. Interval A. \nWhereas, stats that require the end time as well for calculations like 'averageHandledTime', will be present in the interval where the contact ended i.e. interval B. \n\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients. \n", + "description": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope.", "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -121000,55 +131069,36 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 401, "cookie": [], "header": [ @@ -121061,7 +131111,7 @@ "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -121070,184 +131120,130 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", + "header": [], + "name": "No Content", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "Bad Request" + "status": "No Content" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Forbidden", + "name": "Validation Error", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"intervalStartTime\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"channelType\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalEnqueuedTasks\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalAbandonedTasks\": \"\",\n \"averageEnqueuedTime\": \"\",\n \"averageHandledTime\": \"\",\n \"serviceLevelThresholdPercentage\": \"\"\n },\n {\n \"intervalStartTime\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"channelType\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalEnqueuedTasks\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalAbandonedTasks\": \"\",\n \"averageEnqueuedTime\": \"\",\n \"averageHandledTime\": \"\",\n \"serviceLevelThresholdPercentage\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { @@ -121255,11 +131251,11 @@ "value": "application/json" } ], - "name": "OK", + "name": "Forbidden Operation", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -121268,51 +131264,36 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "OK" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 500, "cookie": [], "header": [ @@ -121325,7 +131306,7 @@ "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, @@ -121334,57 +131315,37 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "queues", - "statistics" + "subscriptions", + ":id" ], "query": [ { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.", - "key": "queueIds", - "value": "" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v1/queues/statistics?from=&to=&interval=&queueIds=&orgId=" + "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Internal Server Error" } ] - } - ], - "name": "Queues" - }, - { - "item": [ + }, { - "name": "Subscribe Realtime Notification", + "name": "Update Subscription", "request": { "body": { "mode": "raw", @@ -121394,10 +131355,15 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, - "description": "Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'atlas-portal.partner.helpdesk', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin' for authorization", + "description": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope.", "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -121407,24 +131373,30 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"webSocketUrl\": \"\",\n \"subscriptionId\": {\n \"description\": \"Id used by client to subscribe to interested events.\",\n \"example\": \"ExtensiveSupervisoryDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391\",\n \"format\": \"uuid\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -121432,7 +131404,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Validation Error", "originalRequest": { "body": { "mode": "raw", @@ -121442,9 +131414,14 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -121454,28 +131431,38 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "OK" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 401, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -121485,36 +131472,55 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -121524,36 +131530,55 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id" + } + ] } }, - "status": "Service Unavailable" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -121563,36 +131588,55 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 403, "cookie": [], - "header": [], - "name": "Forbidden Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden Operation", "originalRequest": { "body": { "mode": "raw", @@ -121602,87 +131646,83 @@ "language": "json" } }, - "raw": "{\n \"isKeepAliveEnabled\": true,\n \"clientType\": \"DefaultClient\",\n \"allowMultiLogin\": false,\n \"force\": false\n}" + "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "realtime", - "subscribe" + "subscriptions", + ":id" ], - "raw": "{{baseUrl}}/v1/realtime/subscribe" + "raw": "{{baseUrl}}/v1/subscriptions/:id", + "variable": [ + { + "key": "id" + } + ] } }, "status": "Forbidden" } ] - } - ], - "name": "Realtime" - }, - { - "item": [ + }, { - "name": "Search tasks", + "name": "List Event Types", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, - "description": "The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n- **Required Roles:** Administrator or Supervisor\n\nMandatory parameters are FROM and TO, which accept datetime in epoch format. The FROM parameter cannot be older than 36 months from the current time. The TO parameter, if given as a future time, will be set to the current time. Optional parameters such as filter and aggregation are accepted for each query.\n\nResponse Compression: For this API, response compression using gzip can be enabled by including the 'Accept-Encoding' header in the request with its value as 'gzip'. The response will be compressed only if its size exceeds 1 MB. If the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma-separated encodings), then the API response will not be compressed, impacting latency as observed from clients.", + "description": "Retrieve all available event types for an organization. Requires `cjp:config_read` scope.", "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "", + "body": "{\n \"data\": [\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n },\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -121693,113 +131733,87 @@ ], "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Not Found", + "name": "Unauthorized Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, - "status": "Not Found" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -121807,173 +131821,171 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 409, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Conflict", + "name": "Validation Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, - "status": "Conflict" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "*/*" + "value": "application/json" } ], - "name": "Forbidden", + "name": "Forbidden Operation", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", - "value": "*/*" + "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v1", + "event-types" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v1/event-types?orgId=" } }, "status": "Forbidden" - }, + } + ] + }, + { + "name": "List Subscriptions", + "request": { + "description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V2 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "subscriptions" + ], + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -121981,57 +131993,44 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Validation Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v2", + "subscriptions" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "body": "{\n \"data\": [\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n },\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -122039,57 +132038,44 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v2", + "subscriptions" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 413, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -122097,99 +132083,44 @@ "value": "application/json" } ], - "name": "Content Too Large", + "name": "An Unexpected Error Occurred", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"variables\": {},\n \"query\": \"\"\n}" - }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" }, - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "search" + "v2", + "subscriptions" ], "query": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/search?orgId=" + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" } }, - "status": "Request Entity Too Large" - } - ] - } - ], - "name": "Search" - }, - { - "item": [ - { - "name": "List Subscriptions", - "request": { - "description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V1 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" - } - }, - "response": [ + "status": "Internal Server Error" + }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 401, "cookie": [], "header": [ { @@ -122197,7 +132128,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -122216,7 +132147,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], "query": [ @@ -122226,10 +132157,10 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", @@ -122261,7 +132192,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], "query": [ @@ -122271,145 +132202,10 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" + "raw": "{{baseUrl}}/v2/subscriptions?orgId=" } }, "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n },\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/subscriptions?orgId=" - } - }, - "status": "OK" } ] }, @@ -122424,7 +132220,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "description": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope.", "header": [ @@ -122448,17 +132244,17 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -122466,7 +132262,7 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -122476,7 +132272,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -122499,18 +132295,18 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, - "status": "Bad Request" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -122518,7 +132314,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Forbidden Operation", "originalRequest": { "body": { "mode": "raw", @@ -122528,7 +132324,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -122551,18 +132347,18 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", - "code": 201, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -122570,7 +132366,7 @@ "value": "application/json" } ], - "name": "Created", + "name": "Validation Error", "originalRequest": { "body": { "mode": "raw", @@ -122580,7 +132376,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -122603,18 +132399,18 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, - "status": "Created" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 401, "cookie": [], "header": [ { @@ -122622,7 +132418,7 @@ "value": "application/json" } ], - "name": "Forbidden Operation", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -122632,7 +132428,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -122655,18 +132451,18 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -122674,7 +132470,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -122684,7 +132480,7 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"http://;(!{^\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -122707,13 +132503,13 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions" ], - "raw": "{{baseUrl}}/v1/subscriptions" + "raw": "{{baseUrl}}/v2/subscriptions" } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] }, @@ -122738,7 +132534,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -122749,7 +132545,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id", @@ -122762,7 +132558,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 500, "cookie": [], "header": [ { @@ -122770,7 +132566,7 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -122789,7 +132585,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -122800,7 +132596,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -122808,12 +132604,12 @@ ] } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -122821,7 +132617,7 @@ "value": "application/json" } ], - "name": "Forbidden Operation", + "name": "OK", "originalRequest": { "header": [ { @@ -122840,7 +132636,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -122851,7 +132647,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -122859,12 +132655,12 @@ ] } }, - "status": "Forbidden" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -122872,7 +132668,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -122891,7 +132687,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -122902,7 +132698,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -122910,12 +132706,12 @@ ] } }, - "status": "OK" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -122923,7 +132719,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Forbidden Operation", "originalRequest": { "header": [ { @@ -122942,7 +132738,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -122953,7 +132749,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -122961,12 +132757,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -122974,7 +132770,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Validation Error", "originalRequest": { "header": [ { @@ -122993,7 +132789,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123004,7 +132800,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123012,7 +132808,7 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" } ] }, @@ -123037,7 +132833,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123048,7 +132844,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id", @@ -123061,7 +132857,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "code": 400, "cookie": [], "header": [ { @@ -123069,7 +132865,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "Validation Error", "originalRequest": { "header": [ { @@ -123088,7 +132884,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123099,7 +132895,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123107,21 +132903,30 @@ ] } }, - "status": "Unauthorized" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden Operation", "originalRequest": { "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "DELETE", @@ -123130,7 +132935,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123141,7 +132946,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123149,12 +132954,12 @@ ] } }, - "status": "No Content" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -123162,7 +132967,7 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { @@ -123181,7 +132986,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123192,7 +132997,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123200,30 +133005,21 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden Operation", + "header": [], + "name": "No Content", "originalRequest": { "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", "key": "TrackingId", "value": "" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "DELETE", @@ -123232,7 +133028,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123243,7 +133039,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123251,7 +133047,7 @@ ] } }, - "status": "Forbidden" + "status": "No Content" }, { "_postman_previewlanguage": "json", @@ -123283,7 +133079,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], @@ -123294,7 +133090,7 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/subscriptions/:id?orgId=", + "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", "variable": [ { "key": "id" @@ -123317,7 +133113,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "description": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope.", "header": [ @@ -123341,11 +133137,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id", @@ -123358,7 +133154,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "code": 401, "cookie": [], "header": [ { @@ -123366,7 +133162,7 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Unauthorized Operation", "originalRequest": { "body": { "mode": "raw", @@ -123376,7 +133172,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -123399,11 +133195,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id" @@ -123411,12 +133207,12 @@ ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -123424,7 +133220,7 @@ "value": "application/json" } ], - "name": "Unauthorized Operation", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -123434,7 +133230,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -123457,11 +133253,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id" @@ -123469,12 +133265,12 @@ ] } }, - "status": "Unauthorized" + "status": "OK" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -123482,7 +133278,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "body": { "mode": "raw", @@ -123492,7 +133288,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -123515,11 +133311,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id" @@ -123527,12 +133323,12 @@ ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "code": 403, "cookie": [], "header": [ { @@ -123540,7 +133336,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Forbidden Operation", "originalRequest": { "body": { "mode": "raw", @@ -123550,7 +133346,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -123573,11 +133369,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id" @@ -123585,12 +133381,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "code": 400, "cookie": [], "header": [ { @@ -123598,7 +133394,7 @@ "value": "application/json" } ], - "name": "Forbidden Operation", + "name": "Validation Error", "originalRequest": { "body": { "mode": "raw", @@ -123608,7 +133404,7 @@ "language": "json" } }, - "raw": "{\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"https://@\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" }, "header": [ { @@ -123631,11 +133427,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "subscriptions", ":id" ], - "raw": "{{baseUrl}}/v1/subscriptions/:id", + "raw": "{{baseUrl}}/v2/subscriptions/:id", "variable": [ { "key": "id" @@ -123643,14 +133439,14 @@ ] } }, - "status": "Forbidden" + "status": "Bad Request" } ] }, { "name": "List Event Types", "request": { - "description": "Retrieve all available event types for an organization. Requires `cjp:config_read` scope.", + "description": "Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires `cjp:config_read` scope. ", "header": [ { "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", @@ -123668,7 +133464,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "event-types" ], "query": [ @@ -123678,14 +133474,14 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v2/event-types?orgId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n },\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], "header": [ { @@ -123693,7 +133489,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { @@ -123712,7 +133508,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "event-types" ], "query": [ @@ -123722,10 +133518,55 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v2/event-types?orgId=" } }, - "status": "OK" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Forbidden Operation", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "event-types" + ], + "query": [ + { + "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v2/event-types?orgId=" + } + }, + "status": "Forbidden" }, { "_postman_previewlanguage": "json", @@ -123757,7 +133598,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "event-types" ], "query": [ @@ -123767,15 +133608,15 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v2/event-types?orgId=" } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "{\n \"data\": [\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n },\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n }\n ],\n \"meta\": {\n \"resourceVersionList\": [\n {\n \"resource\": \"\",\n \"version\": \"\"\n },\n {\n \"resource\": \"\",\n \"version\": \"\"\n }\n ],\n \"orgId\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -123783,7 +133624,7 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { @@ -123802,7 +133643,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "event-types" ], "query": [ @@ -123812,10 +133653,10 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v2/event-types?orgId=" } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "json", @@ -123847,7 +133688,7 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "event-types" ], "query": [ @@ -123857,314 +133698,970 @@ "value": "" } ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v2/event-types?orgId=" + } + }, + "status": "Bad Request" + } + ] + } + ], + "name": "Subscriptions" + }, + { + "item": [ + { + "name": "Login", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The login request was accepted for processing", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" } }, "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "login" + ], + "raw": "{{baseUrl}}/v1/agents/login" + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "Logout", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" ], - "name": "Forbidden Operation", + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The logout request was accepted for processing", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "logout" + ], + "raw": "{{baseUrl}}/v1/agents/logout" + } + }, + "status": "Forbidden" + } + ] + }, + { + "name": "State Change", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The state change request was accepted for processing", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "session", + "state" + ], + "raw": "{{baseUrl}}/v1/agents/session/state" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + }, + "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v1/event-types?orgId=" + "raw": "{{baseUrl}}/v1/agents/session/state" } }, - "status": "Forbidden" + "status": "Service Unavailable" } ] }, { - "name": "List Subscriptions", + "name": "Reload", "request": { - "description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V2 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", + "header": [], + "name": "Internal Server Error", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"active\",\n \"description\": \"\"\n },\n {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, - "status": "OK" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "The reload request was accepted for processing", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, - "status": "Unauthorized" + "status": "Accepted" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden Operation", + "header": [], + "name": "Forbidden Request", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "v1", + "agents", + "reload" ], - "raw": "{{baseUrl}}/v2/subscriptions?orgId=" + "raw": "{{baseUrl}}/v1/agents/reload" } }, "status": "Forbidden" @@ -124172,7 +134669,7 @@ ] }, { - "name": "Register Subscription", + "name": "Buddy Agents List", "request": { "body": { "mode": "raw", @@ -124182,22 +134679,13 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, - "description": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope.", + "description": "Returns the list of agents in the given state and media according to agent profile settings. Requires 'cjp:user' scope for authorization.", "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -124206,25 +134694,21 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -124234,21 +134718,12 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -124257,26 +134732,22 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, - "status": "Created" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden Operation", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -124286,21 +134757,12 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -124309,26 +134771,22 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", + "header": [], + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -124338,21 +134796,12 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -124361,26 +134810,22 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -124390,21 +134835,12 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -124413,26 +134849,22 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "The buddy agents request was accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -124442,20 +134874,50 @@ "language": "json" } }, - "raw": "{\n \"destinationUrl\": \"https://\\\"v5qT.\",\n \"eventTypes\": [\n \"\"\n ],\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "buddyList" + ], + "raw": "{{baseUrl}}/v1/agents/buddyList" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } }, + "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" + }, + "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -124465,23 +134927,24 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions" + "v1", + "agents", + "buddyList" ], - "raw": "{{baseUrl}}/v2/subscriptions" + "raw": "{{baseUrl}}/v1/agents/buddyList" } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] }, { - "name": "Get Subscription", + "name": "Get Agent Activities", "request": { - "description": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope.", + "description": "Retrieve agent activities. Sorted by start time ascending.\nMaximum number of records that can be fetched for the given from and to is 10,000. \nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124496,31 +134959,255 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&channelTypes=email&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], "header": [ { @@ -124528,11 +135215,11 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "Bad Request", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124547,30 +135234,141 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "agents", + "activities" + ], + "query": [ { - "key": "id" + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"active\": \"\",\n \"agentDn\": \"\",\n \"agentId\": \"\",\n \"agentLogin\": \"\",\n \"agentName\": \"\",\n \"agentSessionId\": \"\",\n \"channelId\": \"\",\n \"channelType\": \"\",\n \"currentState\": \"\",\n \"endTime\": \"\",\n \"idleCode\": \"\",\n \"idleCodeName\": \"\",\n \"isLogin\": \"\",\n \"mmProfileType\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"reason\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"startTime\": \"\",\n \"subChannelType\": \"\",\n \"taskId\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\",\n \"wrapupCodeName\": \"\"\n },\n {\n \"active\": \"\",\n \"agentDn\": \"\",\n \"agentId\": \"\",\n \"agentLogin\": \"\",\n \"agentName\": \"\",\n \"agentSessionId\": \"\",\n \"channelId\": \"\",\n \"channelType\": \"\",\n \"currentState\": \"\",\n \"endTime\": \"\",\n \"idleCode\": \"\",\n \"idleCodeName\": \"\",\n \"isLogin\": \"\",\n \"mmProfileType\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"reason\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"startTime\": \"\",\n \"subChannelType\": \"\",\n \"taskId\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\",\n \"wrapupCodeName\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -124583,7 +135381,7 @@ "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124598,49 +135396,79 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "Forbidden", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], "method": "GET", @@ -124649,31 +135477,61 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 413, "cookie": [], "header": [ { @@ -124681,11 +135539,11 @@ "value": "application/json" } ], - "name": "Forbidden Operation", + "name": "Content Too Large", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124700,31 +135558,61 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, - "status": "Forbidden" + "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -124732,11 +135620,11 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124751,36 +135639,66 @@ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "activities" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", + "key": "agentIds", + "value": "" + }, + { + "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", + "key": "teamIds", + "value": "" + }, + { + "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", + "key": "page", + "value": "0" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" } }, - "status": "Bad Request" + "status": "Unauthorized" } ] }, { - "name": "Delete Subscription", + "name": "Get Agent Statistics", "request": { - "description": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope.", + "description": "Retrieve Agent statistics information for specified time duration and interval.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124789,36 +135707,145 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&orgId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", "code": 400, "cookie": [], "header": [ @@ -124827,11 +135854,11 @@ "value": "application/json" } ], - "name": "Validation Error", + "name": "Bad Request", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124840,37 +135867,52 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], "header": [ { @@ -124878,11 +135920,11 @@ "value": "application/json" } ], - "name": "Forbidden Operation", + "name": "Unauthorized Operation", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -124891,130 +135933,184 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "*/*" } ], - "name": "Unauthorized Operation", + "name": "Forbidden", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, { "key": "Accept", - "value": "application/json" + "value": "*/*" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" } }, - "status": "Unauthorized" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 204, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "No Content", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" } }, - "status": "No Content" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "body": "{\n \"data\": [\n {\n \"channels\": [\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n },\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n }\n ],\n \"intervalStartTime\": \"\",\n \"agentId\": \"\",\n \"agentName\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\"\n },\n {\n \"channels\": [\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n },\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n }\n ],\n \"intervalStartTime\": \"\",\n \"agentId\": \"\",\n \"agentName\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -125022,11 +136118,11 @@ "value": "application/json" } ], - "name": "An Unexpected Error Occurred", + "name": "OK", "originalRequest": { "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", "key": "TrackingId", "value": "" }, @@ -125035,37 +136131,52 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "subscriptions", - ":id" + "v1", + "agents", + "statistics" ], "query": [ { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", + "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", + "key": "from", + "value": "" + }, + { + "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", + "key": "to", + "value": "" + }, + { + "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", + "key": "interval", + "value": "" + }, + { + "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", + "key": "agentIds", + "value": "" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", "key": "orgId", "value": "" } ], - "raw": "{{baseUrl}}/v2/subscriptions/:id?orgId=", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" } }, - "status": "Internal Server Error" + "status": "OK" } ] }, { - "name": "Update Subscription", + "name": "State Change", "request": { "body": { "mode": "raw", @@ -125075,56 +136186,37 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, - "description": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope.", + "description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "subscriptions", - ":id" + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id", - "value": "" - } - ] + "raw": "{{baseUrl}}/v2/agents/session/state" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "The state change request was accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -125134,55 +136226,37 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "subscriptions", - ":id" + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v2/agents/session/state" } }, - "status": "Unauthorized" + "status": "Accepted" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"createdBy\": \"\",\n \"createdTime\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedBy\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"resourceVersion\": \"\",\n \"status\": \"inactive\",\n \"description\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -125192,55 +136266,37 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "subscriptions", - ":id" + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v2/agents/session/state" } }, - "status": "OK" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -125250,55 +136306,37 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "subscriptions", - ":id" + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v2/agents/session/state" } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden Operation", + "header": [], + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -125308,55 +136346,37 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "PATCH", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "subscriptions", - ":id" + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id" - } - ] + "raw": "{{baseUrl}}/v2/agents/session/state" } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", + "header": [], + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -125366,312 +136386,72 @@ "language": "json" } }, - "raw": "{\n \"resourceVersion\": \"\",\n \"description\": \"\",\n \"eventTypes\": [\n \"\"\n ],\n \"destinationUrl\": \"http://PO\",\n \"status\": \"active\",\n \"secret\": \"\",\n \"orgId\": \"\"\n}" + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" }, "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PATCH", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v2", - "subscriptions", - ":id" - ], - "raw": "{{baseUrl}}/v2/subscriptions/:id", - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "Bad Request" - } - ] - }, - { - "name": "List Event Types", - "request": { - "description": "Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires `cjp:config_read` scope. ", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" + "raw": "{{baseUrl}}/v2/agents/session/state" } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Forbidden Operation", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Forbidden Request", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n },\n {\n \"action\": \"\",\n \"name\": \"\",\n \"resource\": \"\"\n }\n ],\n \"meta\": {\n \"resourceVersionList\": [\n {\n \"resource\": \"\",\n \"version\": \"\"\n },\n {\n \"resource\": \"\",\n \"version\": \"\"\n }\n ],\n \"orgId\": \"\"\n }\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Validation Error", - "originalRequest": { + "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" + }, "header": [ { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v2", - "event-types" - ], - "query": [ - { - "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.", - "key": "orgId", - "value": "" - } + "agents", + "session", + "state" ], - "raw": "{{baseUrl}}/v2/event-types?orgId=" + "raw": "{{baseUrl}}/v2/agents/session/state" } }, - "status": "Bad Request" + "status": "Forbidden" } ] - } - ], - "name": "Subscriptions" - }, - { - "item": [ + }, { "name": "Login", "request": { @@ -125685,7 +136465,7 @@ }, "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" }, - "description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", "header": [ { "key": "Content-Type", @@ -125698,21 +136478,21 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 500, "cookie": [], "header": [], - "name": "The login request was accepted for processing", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -125736,22 +136516,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, - "status": "Accepted" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 400, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -125775,22 +136555,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, - "status": "Unauthorized" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 403, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -125814,22 +136594,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, - "status": "Bad Request" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 202, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "The login request was accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -125853,14 +136633,14 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, - "status": "Internal Server Error" + "status": "Accepted" }, { "_postman_previewlanguage": "text", @@ -125892,11 +136672,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, "status": "Service Unavailable" @@ -125904,10 +136684,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -125931,14 +136711,14 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "login" ], - "raw": "{{baseUrl}}/v1/agents/login" + "raw": "{{baseUrl}}/v2/agents/login" } }, - "status": "Forbidden" + "status": "Unauthorized" } ] }, @@ -125955,7 +136735,7 @@ }, "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" }, - "description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", "header": [ { "key": "Content-Type", @@ -125968,11 +136748,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, "response": [ @@ -126006,11 +136786,11 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, "status": "Unauthorized" @@ -126018,10 +136798,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -126045,22 +136825,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 400, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -126084,22 +136864,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 503, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -126123,22 +136903,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, - "status": "Bad Request" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 403, "cookie": [], "header": [], - "name": "The logout request was accepted for processing", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -126162,22 +136942,22 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, - "status": "Accepted" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 202, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "The logout request was accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -126201,19 +136981,165 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "agents", "logout" ], - "raw": "{{baseUrl}}/v1/agents/logout" + "raw": "{{baseUrl}}/v2/agents/logout" } }, - "status": "Forbidden" + "status": "Accepted" } ] }, { - "name": "State Change", + "name": "Reload", + "request": { + "description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.", + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "status": "Forbidden" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The reload request was accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "agents", + "reload" + ], + "raw": "{{baseUrl}}/v2/agents/reload" + } + }, + "status": "Internal Server Error" + } + ] + } + ], + "name": "Agents" + }, + { + "item": [ + { + "name": "Create Monitoring Request", "request": { "body": { "mode": "raw", @@ -126223,27 +137149,25 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, - "description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Create a successful monitoring request. It can be done either on an on-going or next successful inbound/outbound call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", "header": [ { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, "response": [ @@ -126263,7 +137187,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126271,18 +137195,16 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, "status": "Unauthorized" @@ -126290,10 +137212,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The state change request was accepted for processing", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -126303,7 +137225,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126311,29 +137233,27 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -126343,7 +137263,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126351,29 +137271,27 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 202, "cookie": [], "header": [], - "name": "Bad Request", + "name": "The create request was accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -126383,7 +137301,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126391,29 +137309,27 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, - "status": "Bad Request" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 412, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Precondition Failed", "originalRequest": { "body": { "mode": "raw", @@ -126423,7 +137339,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126431,29 +137347,27 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, - "status": "Forbidden" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -126463,7 +137377,7 @@ "language": "json" } }, - "raw": "{\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"lastStateChangeReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" }, "header": [ { @@ -126471,28 +137385,26 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "session", - "state" + "monitor" ], - "raw": "{{baseUrl}}/v1/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" } ] }, { - "name": "Reload", + "name": "BargeIn Request", "request": { - "description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.", + "description": "Create a successful barge-in request for the supervisor to barge in the call that is being monitored already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", "header": [], "method": "POST", "url": { @@ -126501,20 +137413,59 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 202, + "cookie": [], + "header": [], + "name": "The bargeIn request was accepted for processing", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":taskId", + "bargeIn" + ], + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] + } + }, + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Service Unavailable", "originalRequest": { "header": [], "method": "POST", @@ -126524,21 +137475,28 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden Request", "originalRequest": { "header": [], "method": "POST", @@ -126548,21 +137506,28 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 500, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Internal Server Error", "originalRequest": { "header": [], "method": "POST", @@ -126572,21 +137537,28 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 412, "cookie": [], "header": [], - "name": "The reload request was accepted for processing", + "name": "Precondition Failed", "originalRequest": { "header": [], "method": "POST", @@ -126596,21 +137568,28 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] } }, - "status": "Accepted" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "header": [], "method": "POST", @@ -126620,36 +137599,28 @@ ], "path": [ "v1", - "agents", - "reload" + "monitor", + ":taskId", + "bargeIn" ], - "raw": "{{baseUrl}}/v1/agents/reload" + "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "variable": [ + { + "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "key": "taskId" + } + ] } }, - "status": "Forbidden" + "status": "Unauthorized" } ] }, { - "name": "Buddy Agents List", + "name": "End Monitoring Request", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "description": "Returns the list of agents in the given state and media according to agent profile settings. Requires 'cjp:user' scope for authorization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "description": "Allows to successfully end the on-going monitoring request. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "header": [], "method": "POST", "url": { "host": [ @@ -126657,37 +137628,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 412, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Precondition Failed", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126695,38 +137659,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Bad Request" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126734,38 +137690,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126773,38 +137721,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 202, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "The end request was accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126812,38 +137752,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Internal Server Error" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 500, "cookie": [], "header": [], - "name": "The buddy agents request was accepted for processing", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126851,38 +137783,30 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Accepted" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"agentProfileId\": \"\",\n \"mediaType\": \"\",\n \"state\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -126890,1285 +137814,469 @@ ], "path": [ "v1", - "agents", - "buddyList" + "monitor", + ":taskId", + "end" ], - "raw": "{{baseUrl}}/v1/agents/buddyList" + "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "variable": [ + { + "description": "The unique ID represents the task that needs to end.", + "key": "taskId" + } + ] } }, - "status": "Forbidden" + "status": "Unauthorized" } ] }, { - "name": "Get Agent Activities", + "name": "Hold Monitoring Request", "request": { - "description": "Retrieve agent activities. Sorted by start time ascending.\nMaximum number of records that can be fetched for the given from and to is 10,000. \nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "Place the monitoring session on hold for a particular call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId", "value": "" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&teamIds=&channelTypes=email&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "agents", - "activities" - ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "Forbidden Request", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"active\": \"\",\n \"agentDn\": \"\",\n \"agentId\": \"\",\n \"agentLogin\": \"\",\n \"agentName\": \"\",\n \"agentSessionId\": \"\",\n \"channelId\": \"\",\n \"channelType\": \"\",\n \"currentState\": \"\",\n \"endTime\": \"\",\n \"idleCode\": \"\",\n \"idleCodeName\": \"\",\n \"isLogin\": \"\",\n \"mmProfileType\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"reason\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"startTime\": \"\",\n \"subChannelType\": \"\",\n \"taskId\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\",\n \"wrapupCodeName\": \"\"\n },\n {\n \"active\": \"\",\n \"agentDn\": \"\",\n \"agentId\": \"\",\n \"agentLogin\": \"\",\n \"agentName\": \"\",\n \"agentSessionId\": \"\",\n \"channelId\": \"\",\n \"channelType\": \"\",\n \"currentState\": \"\",\n \"endTime\": \"\",\n \"idleCode\": \"\",\n \"idleCodeName\": \"\",\n \"isLogin\": \"\",\n \"mmProfileType\": \"\",\n \"queueId\": \"\",\n \"queueName\": \"\",\n \"reason\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\",\n \"startTime\": \"\",\n \"subChannelType\": \"\",\n \"taskId\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\",\n \"wrapupCodeName\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "The hold request was accepted for processing.", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, - "status": "OK" + "status": "Accepted" }, { "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": null, + "code": 412, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "Forbidden", + "header": [], + "name": "Precondition Failed", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, - "status": "Forbidden" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 413, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Content Too Large", + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, - "status": "Request Entity Too Large" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "activities" + "monitor", + ":taskId", + "hold" ], - "query": [ - { - "description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.", - "key": "agentIds", - "value": "" - }, - { - "description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.", - "key": "teamIds", - "value": "" - }, - { - "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.", - "key": "page", - "value": "0" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/activities?agentIds=&teamIds=&channelTypes=email&from=&to=&pageSize=100&page=0&orgId=" + ] } }, "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "monitor", + ":taskId", + "hold" + ], + "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "variable": [ + { + "description": "The unique ID representing the task that needs to be held.", + "key": "taskId" + } + ] + } + }, + "status": "Internal Server Error" } ] }, { - "name": "Get Agent Statistics", + "name": "Unhold Monitoring Request", "request": { - "description": "Retrieve Agent statistics information for specified time duration and interval.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "Resume a particular monitoring request that was on hold already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId", "value": "" } - ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&agentIds=&orgId=" + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 412, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", + "header": [], + "name": "Precondition Failed", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" + ] } }, - "status": "Bad Request" + "status": "Precondition Failed" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 401, + "_postman_previewlanguage": "text", + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "The resume request was accepted for processing.", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" + ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "body": null, "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "Forbidden", + "header": [], + "name": "Forbidden Request", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" + ] } }, "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "Internal Server Error", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" + ] } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"channels\": [\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n },\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n }\n ],\n \"intervalStartTime\": \"\",\n \"agentId\": \"\",\n \"agentName\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\"\n },\n {\n \"channels\": [\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n },\n {\n \"channelType\": \"\",\n \"totalAssignedTasks\": \"\",\n \"totalOfferedTasks\": \"\",\n \"totalAcceptedTasks\": \"\",\n \"totalRejectedTasks\": \"\",\n \"totalTransferredTasks\": \"\",\n \"totalEngagedDuration\": \"\",\n \"totalHoldDuration\": \"\",\n \"totalWrapUpDuration\": \"\",\n \"totalAvailableTime\": \"\",\n \"totalUnAvailableTime\": \"\",\n \"averageHandledTime\": \"\"\n }\n ],\n \"intervalStartTime\": \"\",\n \"agentId\": \"\",\n \"agentName\": \"\",\n \"teamId\": \"\",\n \"teamName\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "agents", - "statistics" + "monitor", + ":taskId", + "unhold" ], - "query": [ - { - "description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.", - "key": "from", - "value": "" - }, - { - "description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).", - "key": "to", - "value": "" - }, - { - "description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.", - "key": "interval", - "value": "" - }, - { - "description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.", - "key": "agentIds", - "value": "" - }, + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/v1/agents/statistics?from=&to=&interval=&agentIds=&orgId=" + "path": [ + "v1", + "monitor", + ":taskId", + "unhold" + ], + "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "variable": [ + { + "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "key": "taskId" + } + ] } }, - "status": "OK" + "status": "Unauthorized" } ] }, { - "name": "State Change", + "name": "Fetch Monitoring Sessions", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "description": "Fetches all active subscriptions for a given clientID.", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, "response": [ @@ -128178,36 +138286,20 @@ "code": 202, "cookie": [], "header": [], - "name": "The state change request was accepted for processing", + "name": "The fetch session request was accepted for processing.", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, "status": "Accepted" @@ -128220,34 +138312,18 @@ "header": [], "name": "Unauthorized, Token is Invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, "status": "Unauthorized" @@ -128255,354 +138331,246 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 412, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Precondition Failed", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, - "status": "Internal Server Error" + "status": "Precondition Failed" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 500, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"channelType\": [\n \"\",\n \"\"\n ],\n \"state\": \"\",\n \"auxCodeId\": \"\",\n \"reason\": \"\",\n \"agentId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "PUT", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "session", - "state" + "v1", + "monitor", + "sessions" ], - "raw": "{{baseUrl}}/v2/agents/session/state" + "raw": "{{baseUrl}}/v1/monitor/sessions" } }, - "status": "Forbidden" + "status": "Service Unavailable" } ] }, { - "name": "Login", + "name": "Delete Monitoring Request", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "description": "Delete a particular monitoring request that was created. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 202, "cookie": [], "header": [], - "name": "Bad Request", + "name": "The delete request was accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, - "status": "Bad Request" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, - "cookie": [], - "header": [], - "name": "The login request was accepted for processing", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, - "status": "Accepted" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -128612,33 +138580,24 @@ "header": [], "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, "status": "Service Unavailable" @@ -128646,46 +138605,42 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 412, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Precondition Failed", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialNumber\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"teamId\": \"\",\n \"isExtension\": \"\",\n \"deviceType\": \"\",\n \"deviceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "login" + "v1", + "monitor", + ":requestId" ], - "raw": "{{baseUrl}}/v2/agents/login" + "raw": "{{baseUrl}}/v1/monitor/:requestId", + "variable": [ + { + "description": "The id with which the monitoring request has been created.", + "key": "requestId" + } + ] } }, - "status": "Unauthorized" + "status": "Precondition Failed" } ] - }, + } + ], + "name": "Call Monitoring" + }, + { + "item": [ { - "name": "Logout", + "name": "Create Task", "request": { "body": { "mode": "raw", @@ -128695,36 +138650,44 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, - "description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).", + "description": "This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the Call Control API Guide.", "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"id\": \"\"\n }\n}", + "code": 201, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The new task was successfully requested for creation", "originalRequest": { "body": { "mode": "raw", @@ -128734,36 +138697,39 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, - "status": "Unauthorized" + "status": "Created" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 401, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -128773,7 +138739,7 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { @@ -128781,28 +138747,27 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, - "status": "Internal Server Error" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 500, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -128812,7 +138777,7 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { @@ -128820,20 +138785,19 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, - "status": "Bad Request" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -128851,7 +138815,7 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { @@ -128859,17 +138823,16 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, "status": "Service Unavailable" @@ -128890,7 +138853,7 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { @@ -128898,17 +138861,16 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, "status": "Forbidden" @@ -128916,10 +138878,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 400, "cookie": [], "header": [], - "name": "The logout request was accepted for processing", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -128929,7 +138891,7 @@ "language": "json" } }, - "raw": "{\n \"logoutReason\": \"\",\n \"agentId\": \"\"\n}" + "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" }, "header": [ { @@ -128937,171 +138899,476 @@ "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "logout" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/logout" + "raw": "{{baseUrl}}/v1/tasks" } }, - "status": "Accepted" + "status": "Bad Request" } ] }, { - "name": "Reload", + "name": "Get Tasks", "request": { - "description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.", - "header": [], - "method": "POST", + "description": "Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&channelTypes=email&from=&to=&pageSize=100&orgId=" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Forbidden Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" } }, - "status": "Forbidden" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 401, "cookie": [], - "header": [], - "name": "The reload request was accepted for processing", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Unauthorized Operation", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" } }, - "status": "Accepted" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"data\": [\n {\n \"attributes\": {\n \"channelType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"queue\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"assigned\",\n \"captureRequested\": \"\",\n \"origin\": \"\",\n \"destination\": \"\",\n \"direction\": \"\",\n \"reasonCode\": \"\"\n },\n \"id\": \"\"\n },\n {\n \"attributes\": {\n \"channelType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"queue\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"created\",\n \"captureRequested\": \"\",\n \"origin\": \"\",\n \"destination\": \"\",\n \"direction\": \"\",\n \"reasonCode\": \"\"\n },\n \"id\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "OK", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" } }, - "status": "Unauthorized" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "An Unexpected Error Occurred", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" } }, - "status": "Service Unavailable" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 413, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Content Too Large", + "originalRequest": { + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks" + ], + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + } + }, + "status": "Request Entity Too Large" }, { "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "code": 403, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "*/*" + } + ], + "name": "Forbidden", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", + "key": "TrackingId", + "value": "" + }, + { + "key": "Accept", + "value": "*/*" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v2", - "agents", - "reload" + "v1", + "tasks" ], - "raw": "{{baseUrl}}/v2/agents/reload" + "query": [ + { + "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", + "key": "channelTypes", + "value": "email" + }, + { + "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", + "key": "from", + "value": "" + }, + { + "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", + "key": "to", + "value": "" + }, + { + "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", + "key": "pageSize", + "value": "100" + }, + { + "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", + "key": "orgId", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] - } - ], - "name": "Agents" - }, - { - "item": [ + }, { - "name": "Create Monitoring Request", + "name": "Update Task", "request": { "body": { "mode": "raw", @@ -129111,25 +139378,33 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, - "description": "Create a successful monitoring request. It can be done either on an on-going or next successful inbound/outbound call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "description": "This API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization.. For a list of possible response messages, see the Call Control API Guide.", "header": [ { "key": "Content-Type", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId", + "value": "" + } + ] } }, "response": [ @@ -129149,7 +139424,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129157,16 +139432,23 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, "status": "Unauthorized" @@ -129174,10 +139456,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -129187,7 +139469,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129195,27 +139477,34 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 202, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "The request is accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -129225,7 +139514,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129233,27 +139522,34 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Forbidden" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 403, "cookie": [], "header": [], - "name": "The create request was accepted for processing", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -129263,7 +139559,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129271,27 +139567,34 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Accepted" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 412, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -129301,7 +139604,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129309,27 +139612,34 @@ "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor" + "raw": "{{baseUrl}}/v1/tasks/:taskId", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Precondition Failed" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -129339,7 +139649,7 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"monitorType\": \"\",\n \"taskId\": \"\",\n \"queueIds\": [\n \"\",\n \"\"\n ],\n \"teams\": [\n \"\",\n \"\"\n ],\n \"sites\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"trackingId\": \"\",\n \"invisibleMode\": \"\"\n}" + "raw": "{\n \"attributes\": {}\n}" }, "header": [ { @@ -129347,241 +139657,33 @@ "value": "application/json" } ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor" - ], - "raw": "{{baseUrl}}/v1/monitor" - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "BargeIn Request", - "request": { - "description": "Create a successful barge-in request for the supervisor to barge in the call that is being monitored already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, - "cookie": [], - "header": [], - "name": "The bargeIn request was accepted for processing", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId" - } - ] - } - }, - "status": "Accepted" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "cookie": [], - "header": [], - "name": "Service Unavailable", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId" - } - ] - } - }, - "status": "Service Unavailable" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, - "cookie": [], - "header": [], - "name": "Forbidden Request", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId" - } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 412, - "cookie": [], - "header": [], - "name": "Precondition Failed", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "bargeIn" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", - "variable": [ - { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", - "key": "taskId" - } - ] - } - }, - "status": "Precondition Failed" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, - "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", - "originalRequest": { - "header": [], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":taskId", - "bargeIn" + "tasks", + ":taskId" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", + "raw": "{{baseUrl}}/v1/tasks/:taskId", "variable": [ { - "description": "The unique ID representing the task that needs to be barged by the supervisor.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" } ] }, { - "name": "End Monitoring Request", + "name": "Accept Task", "request": { - "description": "Allows to successfully end the on-going monitoring request. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "description": "Access this endpoint when the user has to accept either an inbound or an outbound requests. The request can be social, a chat or an email. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [], "method": "POST", "url": { @@ -129590,14 +139692,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", "value": "" } @@ -129608,10 +139710,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 412, + "code": 401, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "header": [], "method": "POST", @@ -129621,28 +139723,28 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "header": [], "method": "POST", @@ -129652,20 +139754,20 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", @@ -129683,14 +139785,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -129704,7 +139806,7 @@ "code": 202, "cookie": [], "header": [], - "name": "The end request was accepted for processing", + "name": "The request is accepted for processing", "originalRequest": { "header": [], "method": "POST", @@ -129714,14 +139816,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -129732,41 +139834,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "end" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", - "variable": [ - { - "description": "The unique ID represents the task that needs to end.", - "key": "taskId" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Service Unavailable", "originalRequest": { "header": [], "method": "POST", @@ -129776,27 +139847,27 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "end" + "accept" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", "variable": [ { - "description": "The unique ID represents the task that needs to end.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" } ] }, { - "name": "Hold Monitoring Request", + "name": "End Task", "request": { - "description": "Place the monitoring session on hold for a particular call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", + "description": "Access this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [], "method": "POST", "url": { @@ -129805,14 +139876,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", "value": "" } @@ -129823,10 +139894,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 202, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "The request is accepted for processing", "originalRequest": { "header": [], "method": "POST", @@ -129836,28 +139907,28 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Forbidden" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The hold request was accepted for processing.", + "name": "Service Unavailable", "originalRequest": { "header": [], "method": "POST", @@ -129867,28 +139938,28 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 412, + "code": 500, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Internal Server Error", "originalRequest": { "header": [], "method": "POST", @@ -129898,28 +139969,28 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Precondition Failed" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden Request", "originalRequest": { "header": [], "method": "POST", @@ -129929,20 +140000,20 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -129960,59 +140031,43 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "hold" + "end" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/end", "variable": [ { - "description": "The unique ID representing the task that needs to be held.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "monitor", - ":taskId", - "hold" - ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/hold", - "variable": [ - { - "description": "The unique ID representing the task that needs to be held.", - "key": "taskId" - } - ] - } - }, - "status": "Internal Server Error" } ] }, { - "name": "Unhold Monitoring Request", + "name": "Wrap Up Task", "request": { - "description": "Resume a particular monitoring request that was on hold already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "description": "Access this endpoint when the user has to wrap up a call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130020,14 +140075,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", "value": "" } @@ -130038,12 +140093,27 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 412, + "code": 401, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130051,20 +140121,20 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Precondition Failed" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -130072,9 +140142,24 @@ "code": 202, "cookie": [], "header": [], - "name": "The resume request was accepted for processing.", + "name": "The request is accepted for processing", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130082,14 +140167,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -130100,12 +140185,27 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130113,30 +140213,45 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130144,20 +140259,20 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -130167,7 +140282,22 @@ "header": [], "name": "Service Unavailable", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130175,14 +140305,14 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -130191,14 +140321,29 @@ "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, - "code": 401, + "code": 400, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Bad Request", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -130206,208 +140351,379 @@ ], "path": [ "v1", - "monitor", + "tasks", ":taskId", - "unhold" + "wrapup" ], - "raw": "{{baseUrl}}/v1/monitor/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "variable": [ { - "description": "The unique ID representing the task that needs to be resumed and was on hold already.", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Bad Request" } ] }, { - "name": "Fetch Monitoring Sessions", + "name": "Hold Task", "request": { - "description": "Fetches all active subscriptions for a given clientID.", - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "description": "Access this endpoint when the user has to hold a call. When an user is in consulting state, the task will be put on hold. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 401, "cookie": [], "header": [], - "name": "The fetch session request was accepted for processing.", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Accepted" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Forbidden Request", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 412, + "code": 503, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Service Unavailable", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Precondition Failed" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 202, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "The request is accepted for processing", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Internal Server Error" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, - "code": 503, + "code": 400, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Bad Request", "originalRequest": { - "header": [], - "method": "GET", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - "sessions" + "tasks", + ":taskId", + "hold" ], - "raw": "{{baseUrl}}/v1/monitor/sessions" + "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Service Unavailable" + "status": "Bad Request" } ] }, { - "name": "Delete Monitoring Request", + "name": "Resume Task", "request": { - "description": "Delete a particular monitoring request that was created. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.", - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "description": "Access this endpoint when the user has to resume a call from hold. When an user is done consulting, the previously held interaction with the customer should be resumed. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId", "value": "" } ] @@ -130417,122 +140733,186 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 500, "cookie": [], "header": [], - "name": "The delete request was accepted for processing", + "name": "Internal Server Error", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } }, - "status": "Accepted" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -130542,22 +140922,38 @@ "header": [], "name": "Service Unavailable", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } @@ -130565,44 +140961,55 @@ "status": "Service Unavailable" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, - "code": 412, + "code": 400, "cookie": [], "header": [], - "name": "Precondition Failed", + "name": "Bad Request", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"mediaResourceId\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "monitor", - ":requestId" + "tasks", + ":taskId", + "unhold" ], - "raw": "{{baseUrl}}/v1/monitor/:requestId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", "variable": [ { - "description": "The id with which the monitoring request has been created.", - "key": "requestId" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } ] } }, - "status": "Precondition Failed" + "status": "Bad Request" } ] - } - ], - "name": "Call Monitoring" - }, - { - "item": [ + }, { - "name": "Create Task", + "name": "Reject Task", "request": { "body": { "mode": "raw", @@ -130612,17 +141019,13 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, - "description": "This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the Call Control API Guide.", + "description": "Access this endpoint when the user has to reject a task. Once a task is rejected, the status of the user goes to idle from available. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -130632,24 +141035,28 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId", + "value": "" + } + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"id\": \"\"\n }\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "The new task was successfully requested for creation", + "header": [], + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -130659,16 +141066,12 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "method": "POST", @@ -130678,20 +141081,28 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Created" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -130701,7 +141112,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { @@ -130716,12 +141127,20 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -130739,7 +141158,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { @@ -130754,9 +141173,17 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, "status": "Internal Server Error" @@ -130764,10 +141191,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 401, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -130777,7 +141204,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { @@ -130792,20 +141219,28 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 202, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "The request is accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -130815,7 +141250,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { @@ -130830,15 +141265,23 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, - "status": "Forbidden" + "status": "Accepted" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, "code": 400, "cookie": [], @@ -130853,7 +141296,7 @@ "language": "json" } }, - "raw": "{\n \"destination\": \"\",\n \"entryPointId\": \"\",\n \"mediaType\": \"\",\n \"attributes\": {},\n \"outboundType\": \"\",\n \"origin\": \"\",\n \"callback\": {\n \"callbackOrigin\": \"\",\n \"callbackType\": \"\"\n },\n \"customAttributes\": {}\n}" + "raw": "{\n \"mediaResourceId\": \"\"\n}" }, "header": [ { @@ -130868,9 +141311,17 @@ ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "reject" ], - "raw": "{{baseUrl}}/v1/tasks" + "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] } }, "status": "Bad Request" @@ -130878,459 +141329,197 @@ ] }, { - "name": "Get Tasks", + "name": "Pause Recording Task", "request": { - "description": "Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.", - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might want to pause the recording and later on resume recording. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId", "value": "" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", + "header": [], + "name": "Forbidden Request", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Unauthorized Operation", + "header": [], + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": [\n {\n \"attributes\": {\n \"channelType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"queue\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"assigned\",\n \"captureRequested\": \"\",\n \"origin\": \"\",\n \"destination\": \"\",\n \"direction\": \"\",\n \"reasonCode\": \"\"\n },\n \"id\": \"\"\n },\n {\n \"attributes\": {\n \"channelType\": \"\",\n \"createdTime\": \"\",\n \"lastUpdatedTime\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"queue\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"status\": \"created\",\n \"captureRequested\": \"\",\n \"origin\": \"\",\n \"destination\": \"\",\n \"direction\": \"\",\n \"reasonCode\": \"\"\n },\n \"id\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "OK", - "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks" - ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, - { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "An Unexpected Error Occurred", + "header": [], + "name": "Internal Server Error", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 413, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Content Too Large", + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, - "status": "Request Entity Too Large" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", - "body": "{\n \"trackingId\": \"\",\n \"error\": {\n \"key\": \"\",\n \"message\": [\n {\n \"description\": \"\"\n },\n {\n \"description\": \"\"\n }\n ]\n }\n}", - "code": 403, + "body": null, + "code": 202, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "*/*" - } - ], - "name": "Forbidden", + "header": [], + "name": "The request is accepted for processing", "originalRequest": { - "header": [ - { - "description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ", - "key": "TrackingId", - "value": "" - }, - { - "key": "Accept", - "value": "*/*" - } - ], - "method": "GET", + "header": [], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "tasks" + "tasks", + ":taskId", + "record", + "pause" ], - "query": [ - { - "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.", - "key": "channelTypes", - "value": "email" - }, - { - "description": "Filters tasks created after the given epoch timestamp (in milliseconds).", - "key": "from", - "value": "" - }, - { - "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.", - "key": "to", - "value": "" - }, - { - "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.", - "key": "pageSize", - "value": "100" - }, + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "variable": [ { - "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.", - "key": "orgId", - "value": "" + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" } - ], - "raw": "{{baseUrl}}/v1/tasks?channelTypes=email&from=&to=&pageSize=100&orgId=" + ] } }, - "status": "Forbidden" + "status": "Accepted" } ] }, { - "name": "Update Task", + "name": "Resume Recording Task", "request": { "body": { "mode": "raw", @@ -131340,16 +141529,16 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, - "description": "This API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization.. For a list of possible response messages, see the Call Control API Guide.", + "description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might resume the recording after the pause. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.", "header": [ { "key": "Content-Type", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131357,9 +141546,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131386,7 +141577,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131394,7 +141585,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131402,9 +141593,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131418,10 +141611,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -131431,7 +141624,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131439,7 +141632,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131447,9 +141640,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131458,7 +141653,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", @@ -131476,7 +141671,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131484,7 +141679,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131492,9 +141687,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131508,10 +141705,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -131521,7 +141718,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131529,7 +141726,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131537,9 +141734,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131548,15 +141747,15 @@ ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 403, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -131566,7 +141765,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131574,7 +141773,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131582,9 +141781,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131593,15 +141794,15 @@ ] } }, - "status": "Bad Request" + "status": "Forbidden" }, { - "_postman_previewlanguage": "text", + "_postman_previewlanguage": "Text", "body": null, - "code": 503, + "code": 400, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -131611,7 +141812,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": {}\n}" + "raw": "{\n \"autoResumed\": \"\"\n}" }, "header": [ { @@ -131619,7 +141820,7 @@ "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -131627,9 +141828,11 @@ "path": [ "v1", "tasks", - ":taskId" + ":taskId", + "record", + "resume" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId", + "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131638,15 +141841,30 @@ ] } }, - "status": "Service Unavailable" + "status": "Bad Request" } ] }, { - "name": "Accept Task", + "name": "Transfer Task", "request": { - "description": "Access this endpoint when the user has to accept either an inbound or an outbound requests. The request can be social, a chat or an email. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "description": "Access this endpoint when the user has to transfer a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131656,9 +141874,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131672,12 +141890,27 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131687,9 +141920,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131698,7 +141931,7 @@ ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_postman_previewlanguage": "text", @@ -131708,7 +141941,22 @@ "header": [], "name": "Internal Server Error", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131718,9 +141966,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131739,7 +141987,22 @@ "header": [], "name": "Forbidden Request", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131749,9 +142012,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131765,12 +142028,27 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Service Unavailable", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131780,9 +142058,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131791,17 +142069,32 @@ ] } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 401, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131811,9 +142104,9 @@ "v1", "tasks", ":taskId", - "accept" + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/accept", + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131822,15 +142115,76 @@ ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "Text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "transfer" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] + } + }, + "status": "Bad Request" } ] }, { - "name": "End Task", + "name": "Consult Task", "request": { - "description": "Access this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "description": "Access this endpoint when the user has to consult a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131840,9 +142194,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131856,12 +142210,27 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Service Unavailable", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131871,9 +142240,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131882,17 +142251,32 @@ ] } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 401, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Unauthorized, Token is Invalid", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131902,9 +142286,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131913,17 +142297,32 @@ ] } }, - "status": "Service Unavailable" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131933,9 +142332,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131944,17 +142343,32 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 202, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "The request is accepted for processing", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131964,9 +142378,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -131975,17 +142389,32 @@ ] } }, - "status": "Forbidden" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 500, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Internal Server Error", "originalRequest": { - "header": [], + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "method": "POST", "url": { "host": [ @@ -131995,9 +142424,9 @@ "v1", "tasks", ":taskId", - "end" + "consult" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/end", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132006,12 +142435,58 @@ ] } }, - "status": "Unauthorized" + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "Text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Bad Request", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "consult" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] + } + }, + "status": "Bad Request" } ] }, { - "name": "Wrap Up Task", + "name": "Consult Conference Task", "request": { "body": { "mode": "raw", @@ -132021,9 +142496,9 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, - "description": "Access this endpoint when the user has to wrap up a call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Access this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [ { "key": "Content-Type", @@ -132039,9 +142514,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132068,7 +142544,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132085,9 +142561,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132101,10 +142578,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 403, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -132114,7 +142591,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132131,9 +142608,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132142,15 +142620,15 @@ ] } }, - "status": "Accepted" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 202, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "The request is accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -132160,7 +142638,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132177,9 +142655,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132188,15 +142667,15 @@ ] } }, - "status": "Internal Server Error" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -132206,7 +142685,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132223,9 +142702,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132234,15 +142714,15 @@ ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -132252,7 +142732,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132269,9 +142749,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132280,7 +142761,7 @@ ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "Text", @@ -132298,7 +142779,7 @@ "language": "json" } }, - "raw": "{\n \"wrapUpReason\": \"\",\n \"auxCodeId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132315,9 +142796,10 @@ "v1", "tasks", ":taskId", - "wrapup" + "consult", + "conference" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/wrapup", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132331,7 +142813,7 @@ ] }, { - "name": "Hold Task", + "name": "Consult Transfer Task", "request": { "body": { "mode": "raw", @@ -132341,9 +142823,9 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, - "description": "Access this endpoint when the user has to hold a call. When an user is in consulting state, the task will be put on hold. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Access this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [ { "key": "Content-Type", @@ -132359,9 +142841,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132375,10 +142858,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -132388,7 +142871,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132405,9 +142888,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132416,15 +142900,15 @@ ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -132434,7 +142918,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132451,9 +142935,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132462,15 +142947,15 @@ ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -132480,7 +142965,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132497,9 +142982,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132508,15 +142994,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -132526,7 +143012,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132543,9 +143029,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132554,15 +143041,15 @@ ] } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -132572,7 +143059,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132589,9 +143076,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132600,7 +143088,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "Text", @@ -132618,7 +143106,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" }, "header": [ { @@ -132635,9 +143123,10 @@ "v1", "tasks", ":taskId", - "hold" + "consult", + "transfer" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/hold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132651,25 +143140,10 @@ ] }, { - "name": "Resume Task", + "name": "Consult Accept Task", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "description": "Access this endpoint when the user has to resume a call from hold. When an user is done consulting, the previously held interaction with the customer should be resumed. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "description": "Access this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "header": [], "method": "POST", "url": { "host": [ @@ -132679,9 +143153,10 @@ "v1", "tasks", ":taskId", - "unhold" + "consult", + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132692,6 +143167,70 @@ } }, "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 503, + "cookie": [], + "header": [], + "name": "Service Unavailable", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "consult", + "accept" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, Token is Invalid", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "consult", + "accept" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", + "variable": [ + { + "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] + } + }, + "status": "Unauthorized" + }, { "_postman_previewlanguage": "text", "body": null, @@ -132700,22 +143239,7 @@ "header": [], "name": "The request is accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -132725,9 +143249,10 @@ "v1", "tasks", ":taskId", - "unhold" + "consult", + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132746,22 +143271,7 @@ "header": [], "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -132771,9 +143281,10 @@ "v1", "tasks", ":taskId", - "unhold" + "consult", + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132792,22 +143303,7 @@ "header": [], "name": "Forbidden Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -132817,9 +143313,10 @@ "v1", "tasks", ":taskId", - "unhold" + "consult", + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -132829,31 +143326,45 @@ } }, "status": "Forbidden" - }, + } + ] + }, + { + "name": "Assign Task", + "request": { + "description": "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "assign" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "variable": [ + { + "description": "The unique ID represents the task that the user want to assign.", + "key": "taskId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -132863,43 +143374,59 @@ "v1", "tasks", ":taskId", - "unhold" + "assign" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The unique ID represents the task that the user want to assign.", "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "assign" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "variable": [ + { + "description": "The unique ID represents the task that the user want to assign.", + "key": "taskId" } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], "method": "POST", "url": { "host": [ @@ -132909,43 +143436,59 @@ "v1", "tasks", ":taskId", - "unhold" + "assign" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The unique ID represents the task that the user want to assign.", "key": "taskId" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 401, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Unauthorized", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "assign" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "variable": [ + { + "description": "The unique ID represents the task that the user want to assign.", + "key": "taskId" } - }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + ] + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 202, + "cookie": [], + "header": [], + "name": "The request is accepted for processing", + "originalRequest": { + "header": [], "method": "POST", "url": { "host": [ @@ -132955,23 +143498,23 @@ "v1", "tasks", ":taskId", - "unhold" + "assign" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/unhold", + "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The unique ID represents the task that the user want to assign.", "key": "taskId" } ] } }, - "status": "Bad Request" + "status": "Accepted" } ] }, { - "name": "Reject Task", + "name": "Consult End Task", "request": { "body": { "mode": "raw", @@ -132981,9 +143524,9 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, - "description": "Access this endpoint when the user has to reject a task. Once a task is rejected, the status of the user goes to idle from available. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Access this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [ { "key": "Content-Type", @@ -132999,9 +143542,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133015,10 +143559,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -133028,7 +143572,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133045,9 +143589,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133056,15 +143601,15 @@ ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -133074,7 +143619,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133091,9 +143636,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133102,15 +143648,15 @@ ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -133120,7 +143666,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133137,9 +143683,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133148,7 +143695,7 @@ ] } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -133166,7 +143713,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133183,9 +143730,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133212,7 +143760,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133229,9 +143777,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133258,7 +143807,7 @@ "language": "json" } }, - "raw": "{\n \"mediaResourceId\": \"\"\n}" + "raw": "{\n \"queueId\": \"\"\n}" }, "header": [ { @@ -133275,9 +143824,10 @@ "v1", "tasks", ":taskId", - "reject" + "consult", + "end" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/reject", + "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", @@ -133291,9 +143841,9 @@ ] }, { - "name": "Pause Recording Task", + "name": "Exit Conference Task", "request": { - "description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might want to pause the recording and later on resume recording. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.", + "description": "Access this endpoint when the user wants to exit from a conference call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", "header": [], "method": "POST", "url": { @@ -133304,13 +143854,13 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", "value": "" } @@ -133321,10 +143871,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "header": [], "method": "POST", @@ -133336,27 +143886,27 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { "header": [], "method": "POST", @@ -133368,19 +143918,51 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Unauthorized" + "status": "Accepted" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 403, + "cookie": [], + "header": [], + "name": "Forbidden Request", + "originalRequest": { + "header": [], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "tasks", + ":taskId", + "conference", + "exit" + ], + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "variable": [ + { + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "key": "taskId" + } + ] + } + }, + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -133400,13 +143982,13 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -133432,13 +144014,13 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] @@ -133449,10 +144031,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 402, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Not Found", "originalRequest": { "header": [], "method": "POST", @@ -133464,42 +144046,27 @@ "v1", "tasks", ":taskId", - "record", - "pause" + "conference", + "exit" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/pause", + "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" } ] } }, - "status": "Accepted" + "status": "Payment Required" } ] }, { - "name": "Resume Recording Task", + "name": "Accept Preview Task", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might resume the recording after the pause. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "description": "API to accept the preview campaign task offered to the agent.", + "header": [], "method": "POST", "url": { "host": [ @@ -133507,13 +144074,20 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId", + "value": "" + }, { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", @@ -133526,27 +144100,12 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133554,46 +144113,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 202, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "The request is accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133601,46 +144151,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Service Unavailable" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 401, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Invalid or absent authorization header", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133648,21 +144189,27 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Accepted" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", @@ -133672,22 +144219,7 @@ "header": [], "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133695,16 +144227,22 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } @@ -133714,27 +144252,12 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 503, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133742,46 +144265,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Forbidden" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, "code": 400, "cookie": [], "header": [], "name": "Bad Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"autoResumed\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133789,16 +144303,22 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "record", - "resume" + "accept" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/record/resume", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } @@ -133808,25 +144328,10 @@ ] }, { - "name": "Transfer Task", + "name": "Skip Preview Task", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "description": "Access this endpoint when the user has to transfer a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "description": "API to skip the preview campaign task offered to the agent.", + "header": [], "method": "POST", "url": { "host": [ @@ -133834,12 +144339,20 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId", + "value": "" + }, { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", @@ -133852,27 +144365,12 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 400, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Bad Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133880,45 +144378,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Accepted" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133926,45 +144416,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Invalid or absent authorization header", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -133972,45 +144454,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 500, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134018,45 +144492,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Service Unavailable" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134064,45 +144530,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 403, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134110,43 +144568,35 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "transfer" + "skip" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/transfer", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Bad Request" + "status": "Forbidden" } ] }, { - "name": "Consult Task", + "name": "Remove Preview Task", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "description": "Access this endpoint when the user has to consult a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "description": "API to remove the preview campaign task offered to the agent", + "header": [], "method": "POST", "url": { "host": [ @@ -134154,12 +144604,20 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId", + "value": "" + }, { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId", @@ -134172,27 +144630,12 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134200,45 +144643,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 202, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "The request is accepted for processing", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134246,45 +144681,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Unauthorized" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134292,45 +144719,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 400, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Bad Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134338,45 +144757,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Accepted" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 503, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Service Unavailable", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134384,45 +144795,37 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Internal Server Error" + "status": "Service Unavailable" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 401, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Invalid or absent authorization header", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\",\n \"holdParticipants\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "header": [], "method": "POST", "url": { "host": [ @@ -134430,25 +144833,32 @@ ], "path": [ "v1", - "tasks", + "dialer", + "campaign", + ":campaignId", + "preview-task", ":taskId", - "consult" + "remove" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "variable": [ { "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", "key": "taskId" + }, + { + "description": "The unique ID represents the campaign that the user is currently working on.", + "key": "campaignId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" } ] }, { - "name": "Consult Conference Task", + "name": "Create Task", "request": { "body": { "mode": "raw", @@ -134458,13 +144868,17 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, - "description": "Access this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Creates a Work Item task. Requires `CJP_User` scope for authorization.", "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -134473,30 +144887,20 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", - "value": "" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 503, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -134506,7 +144910,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { @@ -134520,30 +144924,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, - "status": "Unauthorized" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 401, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -134553,7 +144948,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { @@ -134567,30 +144962,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, - "status": "Forbidden" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 500, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -134600,7 +144986,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { @@ -134614,30 +145000,26 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, - "status": "Accepted" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"orgId\": \"\"\n },\n \"data\": {\n \"id\": \"\"\n }\n}", + "code": 201, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The new task was successfully requested for creation", "originalRequest": { "body": { "mode": "raw", @@ -134647,12 +145029,16 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -134661,30 +145047,21 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, - "status": "Service Unavailable" + "status": "Created" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 403, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -134694,7 +145071,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { @@ -134708,25 +145085,16 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, "code": 400, "cookie": [], @@ -134741,7 +145109,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"agentId\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"orgId\": \"\",\n \"origin\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"destination\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"mediaType\": \"workItem\",\n \"channel\": \"\",\n \"direction\": {\n \"type\": \"OUTBOUND\"\n },\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n },\n \"mediaMgr\": \"\",\n \"trackingId\": \"\",\n \"eventTime\": \"\",\n \"flowSettings\": {\n \"key_0\": \"\"\n },\n \"globalVariables\": {\n \"key_0\": \"\"\n }\n}" }, "header": [ { @@ -134755,19 +145123,10 @@ "{{baseUrl}}" ], "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "conference" + "v2", + "tasks" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "raw": "{{baseUrl}}/v2/tasks" } }, "status": "Bad Request" @@ -134775,7 +145134,7 @@ ] }, { - "name": "Consult Transfer Task", + "name": "Update Task", "request": { "body": { "mode": "raw", @@ -134785,12 +145144,16 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, - "description": "Access this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Appends a Work Item message to an existing task. This is an asynchronous operation. Requires `CJP_User` scope for authorization.", "header": [ { - "key": "Content-Type", + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", "value": "application/json" } ], @@ -134800,16 +145163,15 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", + "description": "The unique ID of the Work Item task.", "key": "taskId", "value": "" } @@ -134820,10 +145182,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 503, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Service Unavailable", "originalRequest": { "body": { "mode": "raw", @@ -134833,7 +145195,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { @@ -134847,30 +145209,30 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Accepted" + "status": "Service Unavailable" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Unauthorized, Token is Invalid", + "name": "Forbidden Request", "originalRequest": { "body": { "mode": "raw", @@ -134880,7 +145242,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { @@ -134894,30 +145256,30 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 500, + "code": 400, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -134927,7 +145289,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { @@ -134941,30 +145303,35 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{}", + "code": 202, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "The request is accepted for processing", "originalRequest": { "body": { "mode": "raw", @@ -134974,12 +145341,16 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -134988,30 +145359,30 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Service Unavailable" + "status": "Accepted" }, { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 500, "cookie": [], "header": [], - "name": "Forbidden Request", + "name": "Internal Server Error", "originalRequest": { "body": { "mode": "raw", @@ -135021,7 +145392,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { @@ -135035,30 +145406,30 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "Text", + "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 401, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Unauthorized, Token is Invalid", "originalRequest": { "body": { "mode": "raw", @@ -135068,7 +145439,7 @@ "language": "json" } }, - "raw": "{\n \"to\": \"\",\n \"destinationType\": \"\"\n}" + "raw": "{\n \"mediaParams\": {\n \"type\": \"work-item-form\",\n \"message\": {\n \"aliasId\": \"\",\n \"workItemData\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"outdialEntryPointId\": \"\"\n }\n}" }, "header": [ { @@ -135082,47 +145453,58 @@ "{{baseUrl}}" ], "path": [ - "v1", + "v2", "tasks", ":taskId", - "consult", - "transfer" + "messages" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", + "raw": "{{baseUrl}}/v2/tasks/:taskId/messages", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "description": "The unique ID of the Work Item task.", + "key": "taskId", + "value": "" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" } ] - }, + } + ], + "name": "Tasks" + }, + { + "item": [ { - "name": "Consult Accept Task", + "name": "Get Workspace", "request": { - "description": "Access this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [], - "method": "POST", + "description": "Get workspace details. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "accept" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" } ] @@ -135130,250 +145512,125 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "cookie": [], - "header": [], - "name": "Service Unavailable", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "accept" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] - } - }, - "status": "Service Unavailable" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, - "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "accept" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "The request is accepted for processing", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "accept" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Accepted" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error", + ], + "name": "Ok", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "accept" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Forbidden Request", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "accept" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] - } - }, - "status": "Forbidden" - } - ] - }, - { - "name": "Assign Task", - "request": { - "description": "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).", - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "assign" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", - "variable": [ + "header": [ { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId", - "value": "" + "key": "Content-Type", + "value": "application/json" } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "cookie": [], - "header": [], - "name": "Service Unavailable", + ], + "name": "Resource already exists", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "assign" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "assign" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId" + "key": "workspaceId" } ] } @@ -135381,102 +145638,93 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Forbidden Request", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "assign" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", - "variable": [ - { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, - "cookie": [], - "header": [], - "name": "Unauthorized", + ], + "name": "Too many requests", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "assign" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "The request is accepted for processing", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "assign" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/assign", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user want to assign.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Accepted" + "status": "Not Found" } ] }, { - "name": "Consult End Task", + "name": "Update Workspace", "request": { "body": { "mode": "raw", @@ -135486,32 +145734,37 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, - "description": "Access this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", + "description": "Update workspace by Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" } ] @@ -135519,12 +145772,17 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", "originalRequest": { "body": { "mode": "raw", @@ -135534,91 +145792,53 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "consult", - "end" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "cookie": [], - "header": [], - "name": "Service Unavailable", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } }, - "raw": "{\n \"queueId\": \"\"\n}" - }, - "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Forbidden Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", "originalRequest": { "body": { "mode": "raw", @@ -135628,44 +145848,53 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", "originalRequest": { "body": { "mode": "raw", @@ -135675,44 +145904,53 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Unauthorized" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], - "header": [], - "name": "The request is accepted for processing", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { "body": { "mode": "raw", @@ -135722,44 +145960,53 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Accepted" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "Text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Bad Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", "originalRequest": { "body": { "mode": "raw", @@ -135769,61 +146016,71 @@ "language": "json" } }, - "raw": "{\n \"queueId\": \"\"\n}" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "consult", - "end" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/consult/end", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Bad Request" + "status": "OK" } ] }, { - "name": "Exit Conference Task", + "name": "Delete Workspace", "request": { - "description": "Access this endpoint when the user wants to exit from a conference call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).", - "header": [], - "method": "POST", + "description": "Delete Workspace By Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" } ] @@ -135831,228 +146088,252 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Unauthorized, Token is Invalid", - "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tasks", - ":taskId", - "conference", - "exit" - ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", - "variable": [ - { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, - "cookie": [], - "header": [], - "name": "The request is accepted for processing", + ], + "name": "Resource not found", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Accepted" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Forbidden Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Forbidden" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Service Unavailable" + "status": "Too Many Requests" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 402, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Not Found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "tasks", - ":taskId", - "conference", - "exit" + "api", + "workspace", + "workspace-id", + ":workspaceId" ], - "raw": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", + "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "variable": [ { - "description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" } ] } }, - "status": "Payment Required" + "status": "Conflict" } ] }, { - "name": "Accept Preview Task", + "name": "Get A specific Template searched by template id", "request": { - "description": "API to accept the preview campaign task offered to the agent.", - "header": [], - "method": "POST", + "description": "Get Template details by template Id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Template ID", + "key": "templateId", "value": "" } ] @@ -136062,262 +146343,401 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 404, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "Not found", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 500, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Internal error", "originalRequest": { "header": [], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Accepted" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Invalid or absent authorization header", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Unauthorized" + "status": "OK" + } + ] + }, + { + "name": "Update existing ProfileViewTemplate", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, + "description": "Update existing Profile View Template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Internal Server Error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", "originalRequest": { - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Service Unavailable", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", "originalRequest": { - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Service Unavailable" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Bad Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "accept" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" } ] }, { - "name": "Skip Preview Task", + "name": "Delete Template by template Id", "request": { - "description": "API to skip the preview campaign task offered to the agent.", - "header": [], - "method": "POST", + "description": "Delete Template By template id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Template ID", + "key": "templateId", "value": "" } ] @@ -136325,151 +146745,200 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Bad Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 404, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Not found", "originalRequest": { "header": [], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 500, "cookie": [], "header": [], - "name": "Invalid or absent authorization header", + "name": "Internal error", "originalRequest": { "header": [], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "templateId" } ] } }, - "status": "Unauthorized" - }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Delete specific Person by id", + "request": { + "description": "Delete Person Details searched by Person id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Person ID", + "key": "personId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, "code": 500, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Internal error", "originalRequest": { "header": [], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } @@ -136479,110 +146948,138 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 202, + "code": 404, "cookie": [], "header": [], - "name": "The request is accepted for processing", + "name": "Not found", "originalRequest": { "header": [], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } }, - "status": "Accepted" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", "originalRequest": { - "header": [], - "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "skip" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } }, - "status": "Forbidden" + "status": "OK" } ] }, { - "name": "Remove Preview Task", + "name": "Add/Remove/Replace details of a Person.", "request": { - "description": "API to remove the preview campaign task offered to the agent", - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + }, + "description": "The Patch Api can be used to add/remove identities(email, phone, customerId) or replace firstName and lastName of an Individual. We support only add, replace and remove operations. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope. \n\nFor a more information on Patch Requests, see this [JSON PATCH guide](https://jsonpatch.com)", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId", + "description": "(Required) Person ID", + "key": "personId", "value": "" } ] @@ -136592,78 +147089,54 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "Bad Request", "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - }, - { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Forbidden" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 202, - "cookie": [], - "header": [], - "name": "The request is accepted for processing", - "originalRequest": { - "header": [], - "method": "POST", + }, + "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } }, - "status": "Accepted" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", @@ -136671,32 +147144,46 @@ "code": 500, "cookie": [], "header": [], - "name": "Internal Server Error", + "name": "Internal error", "originalRequest": { - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } @@ -136706,135 +147193,143 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 404, "cookie": [], "header": [], - "name": "Bad Request", + "name": "Not found", "originalRequest": { - "header": [], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", - "variable": [ - { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" - }, - { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 503, - "cookie": [], - "header": [], - "name": "Service Unavailable", - "originalRequest": { - "header": [], - "method": "POST", + }, + "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } }, - "status": "Service Unavailable" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 401, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 202, "cookie": [], - "header": [], - "name": "Invalid or absent authorization header", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Accepted", "originalRequest": { - "header": [], - "method": "POST", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "admin", "v1", - "dialer", - "campaign", - ":campaignId", - "preview-task", - ":taskId", - "remove" + "api", + "person", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "variable": [ { - "description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.", - "key": "taskId" + "key": "workspaceId" }, { - "description": "The unique ID represents the campaign that the user is currently working on.", - "key": "campaignId" + "key": "personId" } ] } }, - "status": "Unauthorized" + "status": "Accepted" } ] - } - ], - "name": "Tasks" - }, - { - "item": [ + }, { - "name": "Get Workspace", + "name": "Add one/more Identities to a person", "request": { - "description": "Get workspace details. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "This Patch Api can be used to add identities(email, phone, customerId) to a person. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope.", "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -136843,16 +147338,24 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Person ID", + "key": "personId", + "value": "" } ] } @@ -136860,8 +147363,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], "header": [ { @@ -136869,15 +147372,29 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Resource not found", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -136886,24 +147403,30 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "code": 401, "cookie": [], "header": [ { @@ -136911,15 +147434,29 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "UnAuthorized", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -136928,24 +147465,30 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "Conflict" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 400, "cookie": [], "header": [ { @@ -136953,15 +147496,29 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Bad Request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -136970,24 +147527,30 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -136995,15 +147558,29 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Ok", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -137012,24 +147589,30 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "Too Many Requests" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -137037,15 +147620,29 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Internal server error", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" @@ -137054,47 +147651,39 @@ "admin", "v1", "api", - "workspace", + "person", + "add-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" } ] }, { - "name": "Update Workspace", + "name": "Get WXCC Subscription", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "description": "Update workspace by Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "description": "Get WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137103,11 +147692,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "description": "(Required) Workspace ID", @@ -137121,7 +147710,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "code": 404, "cookie": [], "header": [ { @@ -137129,29 +147718,15 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Resource not found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137160,11 +147735,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137172,12 +147747,12 @@ ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -137185,29 +147760,15 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Internal server error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137216,11 +147777,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137228,12 +147789,12 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "code": 409, "cookie": [], "header": [ { @@ -137241,29 +147802,15 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Resource already exists", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137272,11 +147819,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137284,12 +147831,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -137297,29 +147844,15 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Too many requests", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137328,11 +147861,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137340,11 +147873,11 @@ ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -137355,27 +147888,13 @@ ], "name": "Ok", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -137384,11 +147903,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137401,16 +147920,16 @@ ] }, { - "name": "Delete Workspace", + "name": "Create WXCC Subscription", "request": { - "description": "Delete Workspace By Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "description": "Create WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137419,11 +147938,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "description": "(Required) Workspace ID", @@ -137437,7 +147956,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -137445,7 +147964,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Internal server error", "originalRequest": { "header": [ { @@ -137453,7 +147972,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137462,11 +147981,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137474,12 +147993,12 @@ ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -137487,7 +148006,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Resource not found", "originalRequest": { "header": [ { @@ -137495,7 +148014,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137504,11 +148023,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137516,12 +148035,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], "header": [ { @@ -137529,7 +148048,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Resource already exists", "originalRequest": { "header": [ { @@ -137537,7 +148056,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137546,11 +148065,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137558,7 +148077,7 @@ ] } }, - "status": "OK" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -137579,7 +148098,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137588,11 +148107,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137604,8 +148123,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ]\n}", + "code": 201, "cookie": [], "header": [ { @@ -137613,7 +148132,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Created", "originalRequest": { "header": [ { @@ -137621,7 +148140,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -137630,11 +148149,11 @@ "admin", "v1", "api", - "workspace", + "wxcc-subscription", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -137642,21 +148161,21 @@ ] } }, - "status": "Conflict" + "status": "Created" } ] }, { - "name": "Get A specific Template searched by template id", + "name": "Delete WXCC Subscription", "request": { - "description": "Get Template details by template Id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Delete WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -137665,75 +148184,41 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", - "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "templateId" - } - ] + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", + ], + "name": "Resource not found", "originalRequest": { - "header": [], - "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -137742,28 +148227,23 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", + "body": "", "code": 200, "cookie": [], "header": [ @@ -137772,7 +148252,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "No Content", "originalRequest": { "header": [ { @@ -137780,7 +148260,7 @@ "value": "application/json" } ], - "method": "GET", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -137789,86 +148269,24 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "templateId" } ] } }, "status": "OK" - } - ] - }, - { - "name": "Update existing ProfileViewTemplate", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, - "description": "Update existing Profile View Template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], "header": [ { @@ -137876,29 +148294,15 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Internal server error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -137907,29 +148311,24 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "templateId" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -137937,29 +148336,15 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Resource already exists", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -137968,29 +148353,24 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "templateId" } ] } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -137998,29 +148378,15 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Too many requests", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -138029,38 +148395,33 @@ "admin", "v1", "api", - "profile-view-template", + "wxcc-subscription", "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Delete Template by template Id", + "name": "Get All Workspaces", "request": { - "description": "Delete Template By template id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Get All Workspaces. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138069,32 +148430,43 @@ "admin", "v1", "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", "value": "" }, { - "description": "(Required) Template ID", - "key": "templateId", + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], "header": [ { @@ -138102,7 +148474,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Resource already exists", "originalRequest": { "header": [ { @@ -138110,7 +148482,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138119,35 +148491,60 @@ "admin", "v1", "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "templateId" + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, - "status": "OK" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138156,35 +148553,60 @@ "admin", "v1", "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "templateId" + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138193,115 +148615,60 @@ "admin", "v1", "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "templateId" - } - ] - } - }, - "status": "Internal Server Error" - } - ] - }, - { - "name": "Delete specific Person by id", - "request": { - "description": "Delete Person Details searched by Person id in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Person ID", - "key": "personId", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, { - "key": "workspaceId" + "description": "Sort direction", + "key": "sort", + "value": "" }, { - "key": "personId" + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, - "status": "Internal Server Error" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", "originalRequest": { - "header": [], - "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138310,29 +148677,44 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], "header": [ { @@ -138340,7 +148722,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Internal server error", "originalRequest": { "header": [ { @@ -138348,7 +148730,7 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138357,29 +148739,44 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" } }, - "status": "OK" + "status": "Internal Server Error" } ] }, { - "name": "Add/Remove/Replace details of a Person.", + "name": "Create Workspace", "request": { "body": { "mode": "raw", @@ -138389,20 +148786,20 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, - "description": "The Patch Api can be used to add/remove identities(email, phone, customerId) or replace firstName and lastName of an Individual. We support only add, replace and remove operations. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope. \n\nFor a more information on Patch Requests, see this [JSON PATCH guide](https://jsonpatch.com)", + "description": "Create Workspace in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138411,35 +148808,31 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, + "query": [ { - "description": "(Required) Person ID", - "key": "personId", + "description": "Organization ID", + "key": "organizationId", "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], - "header": [], - "name": "Bad Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", "originalRequest": { "body": { "mode": "raw", @@ -138449,15 +148842,19 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138466,32 +148863,32 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "Organization ID", + "key": "organizationId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" } }, - "status": "Bad Request" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", "originalRequest": { "body": { "mode": "raw", @@ -138501,15 +148898,19 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138518,32 +148919,32 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "Organization ID", + "key": "organizationId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" } }, - "status": "Internal Server Error" + "status": "Conflict" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", "originalRequest": { "body": { "mode": "raw", @@ -138553,15 +148954,19 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138570,29 +148975,24 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "Organization ID", + "key": "organizationId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 202, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"organizationId\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"workspaces\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enabledFeatureIds\": [\n \"\",\n \"\"\n ],\n \"settings\": {\n \"general\": {\n \"dataRetentionDays\": \"\"\n },\n \"webex\": {\n \"env\": \"\"\n }\n }\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -138600,7 +149000,7 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Ok", "originalRequest": { "body": { "mode": "raw", @@ -138610,19 +149010,19 @@ "language": "json" } }, - "raw": "[\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n },\n {\n \"op\": \"update\",\n \"path\": \"\",\n \"value\": \"\"\n }\n]" + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138631,52 +149031,89 @@ "admin", "v1", "api", - "person", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "workspace" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "query": [ { - "key": "workspaceId" - }, + "description": "Organization ID", + "key": "organizationId", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "workspace" + ], + "query": [ { - "key": "personId" + "description": "Organization ID", + "key": "organizationId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" } }, - "status": "Accepted" + "status": "Internal Server Error" } ] }, { - "name": "Add one/more Identities to a person", + "name": "Get All Template Details.", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" - }, - "description": "This Patch Api can be used to add identities(email, phone, customerId) to a person. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope.", + "description": "Get Template details by Organization Id and workspaceId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138685,23 +149122,42 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", "value": "" }, { - "description": "(Required) Person ID", - "key": "personId", + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" } ] @@ -138710,8 +149166,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -138719,29 +149175,15 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Success", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -138750,30 +149192,219 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", + "query": [ + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", "variable": [ { "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "profile-view-template", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" } ] } }, "status": "Not Found" }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "profile-view-template", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Create Template", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + }, + "description": "Creates a Profile View Template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "profile-view-template", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 401, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -138781,7 +149412,7 @@ "value": "application/json" } ], - "name": "UnAuthorized", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -138791,19 +149422,19 @@ "language": "json" } }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138812,25 +149443,19 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "personId" } ] } }, - "status": "Unauthorized" + "status": "Created" }, { "_postman_previewlanguage": "json", @@ -138853,19 +149478,19 @@ "language": "json" } }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138874,20 +149499,14 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "personId" } ] } @@ -138896,8 +149515,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], "header": [ { @@ -138905,7 +149524,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Resource not found", "originalRequest": { "body": { "mode": "raw", @@ -138915,19 +149534,19 @@ "language": "json" } }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138936,25 +149555,19 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "personId" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "json", @@ -138977,19 +149590,19 @@ "language": "json" } }, - "raw": "{\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -138998,20 +149611,14 @@ "admin", "v1", "api", - "person", - "add-identities", + "profile-view-template", "workspace-id", - ":workspaceId", - "person-id", - ":personId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" - }, - { - "key": "personId" } ] } @@ -139021,9 +149628,9 @@ ] }, { - "name": "Get WXCC Subscription", + "name": "Get all or a specific Person Details", "request": { - "description": "Get WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "description": "Get Person Details in JDS. If personId is provided by query parameter, this returns the Person whose personId matches the parameter.\nIf not, this will return ALL the Persons within the organization and workspace. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -139039,11 +149646,43 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "query": [ + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", "variable": [ { "description": "(Required) Workspace ID", @@ -139056,8 +149695,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -139065,7 +149704,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Success", "originalRequest": { "header": [ { @@ -139082,11 +149721,107 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "query": [ + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "person", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", "variable": [ { "key": "workspaceId" @@ -139096,10 +149831,124 @@ }, "status": "Not Found" }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "person", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Person ID", + "key": "personId", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "Sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" + } + ] + } + }, + "status": "Internal Server Error" + } + ] + }, + { + "name": "Create a Person", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "Creates a Person in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "person", + "workspace-id", + ":workspaceId" + ], + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -139107,15 +149956,29 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Resource not found", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139124,11 +149987,11 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139136,12 +149999,12 @@ ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -139149,15 +150012,29 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Created", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139166,11 +150043,11 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139178,12 +150055,12 @@ ] } }, - "status": "Conflict" + "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "code": 500, "cookie": [], "header": [ { @@ -139191,15 +150068,29 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "Internal server error", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139208,11 +150099,11 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139220,12 +150111,12 @@ ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], "header": [ { @@ -139233,15 +150124,29 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Bad Request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139250,11 +150155,11 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139262,15 +150167,29 @@ ] } }, - "status": "OK" + "status": "Bad Request" } ] }, { - "name": "Create WXCC Subscription", + "name": "Merges Identities to a Primary Identity.", "request": { - "description": "Create WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" + }, + "description": "Merges one/more Identities to a **Primary** Individual in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -139285,16 +150204,24 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge", "workspace-id", - ":workspaceId" + ":workspaceId", + "primary-person-id", + ":primaryPersonId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Primary Person ID", + "key": "primaryPersonId", + "value": "" } ] } @@ -139302,8 +150229,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 202, "cookie": [], "header": [ { @@ -139311,9 +150238,23 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Accepted", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" @@ -139328,36 +150269,47 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge", "workspace-id", - ":workspaceId" + ":workspaceId", + "primary-person-id", + ":primaryPersonId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "variable": [ { "key": "workspaceId" + }, + { + "key": "primaryPersonId" } ] } }, - "status": "Internal Server Error" + "status": "Accepted" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Not found", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -139370,14 +150322,20 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge", "workspace-id", - ":workspaceId" + ":workspaceId", + "primary-person-id", + ":primaryPersonId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "variable": [ { "key": "workspaceId" + }, + { + "key": "primaryPersonId" } ] } @@ -139385,63 +150343,26 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Internal error", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" - ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ - { - "key": "workspaceId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", - "originalRequest": { + }, + "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -139454,36 +150375,47 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge", "workspace-id", - ":workspaceId" + ":workspaceId", + "primary-person-id", + ":primaryPersonId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "variable": [ { "key": "workspaceId" + }, + { + "key": "primaryPersonId" } ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"createdTime\": \"\",\n \"description\": \"\",\n \"destinationUrl\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastUpdatedTime\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ]\n}", - "code": 201, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Created", + "header": [], + "name": "Bad Request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], @@ -139496,33 +150428,53 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge", "workspace-id", - ":workspaceId" + ":workspaceId", + "primary-person-id", + ":primaryPersonId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "variable": [ { "key": "workspaceId" + }, + { + "key": "primaryPersonId" } ] } }, - "status": "Created" + "status": "Bad Request" } ] }, { - "name": "Delete WXCC Subscription", + "name": "Creates or merges aliases to an Individual in JDS.", "request": { - "description": "Delete WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "Merges one/more aliases in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139531,11 +150483,12 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge-identities", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "variable": [ { "description": "(Required) Workspace ID", @@ -139547,25 +150500,30 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Bad Request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139574,11 +150532,12 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge-identities", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139586,11 +150545,11 @@ ] } }, - "status": "Not Found" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", "code": 200, "cookie": [], "header": [ @@ -139599,15 +150558,29 @@ "value": "application/json" } ], - "name": "No Content", + "name": "OK", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139616,11 +150589,12 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge-identities", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139631,25 +150605,30 @@ "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Internal error", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139658,11 +150637,12 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge-identities", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139673,67 +150653,30 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Not found", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "wxcc-subscription", - "workspace-id", - ":workspaceId" - ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", - "variable": [ - { - "key": "workspaceId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", - "originalRequest": { + }, + "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "DELETE", + "method": "POST", "url": { "host": [ "{{baseUrl}}" @@ -139742,11 +150685,12 @@ "admin", "v1", "api", - "wxcc-subscription", + "person", + "merge-identities", "workspace-id", ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "variable": [ { "key": "workspaceId" @@ -139754,14 +150698,14 @@ ] } }, - "status": "Too Many Requests" + "status": "Not Found" } ] }, { - "name": "Get All Workspaces", + "name": "Get all Journey Actions", "request": { - "description": "Get All Workspaces. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "description": "Get all Journey Actions in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -139777,14 +150721,11 @@ "admin", "v1", "api", - "workspace" + "journey-actions", + "workspace-id", + ":workspaceId" ], "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, { "description": "Sort By Field", "key": "sortBy", @@ -139796,7 +150737,7 @@ "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", "key": "page", "value": "" }, @@ -139806,14 +150747,21 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -139821,7 +150769,7 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Success", "originalRequest": { "header": [ { @@ -139838,14 +150786,11 @@ "admin", "v1", "api", - "workspace" + "journey-actions", + "workspace-id", + ":workspaceId" ], "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, { "description": "Sort By Field", "key": "sortBy", @@ -139857,7 +150802,7 @@ "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", "key": "page", "value": "" }, @@ -139867,92 +150812,25 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "variable": [ { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "key": "workspaceId" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + ] } }, "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Internal error", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -139962,14 +150840,11 @@ "admin", "v1", "api", - "workspace" + "journey-actions", + "workspace-id", + ":workspaceId" ], "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, { "description": "Sort By Field", "key": "sortBy", @@ -139981,7 +150856,7 @@ "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", "key": "page", "value": "" }, @@ -139991,92 +150866,25 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "variable": [ { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "key": "workspaceId" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + ] } }, - "status": "Too Many Requests" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Not found", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -140086,14 +150894,11 @@ "admin", "v1", "api", - "workspace" + "journey-actions", + "workspace-id", + ":workspaceId" ], "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, { "description": "Sort By Field", "key": "sortBy", @@ -140105,7 +150910,7 @@ "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", "key": "page", "value": "" }, @@ -140115,38 +150920,29 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?filter=&sortBy=&sort=&page=&pageSize=" + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" + } + ] } }, - "status": "Internal Server Error" + "status": "Not Found" } ] }, { - "name": "Create Workspace", + "name": "Get A specific Template searched by template name", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "description": "Create Workspace in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "description": "Get Template details by template Name in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140155,109 +150951,38 @@ "admin", "v1", "api", - "workspace" + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-name", + ":templateName" ], - "query": [ + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "variable": [ { - "description": "Organization ID", - "key": "organizationId", + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Template Name", + "key": "templateName", "value": "" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" + ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace" - ], - "query": [ - { - "description": "Organization ID", - "key": "organizationId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Not found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140266,79 +150991,28 @@ "admin", "v1", "api", - "workspace" + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-name", + ":templateName" ], - "query": [ + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "variable": [ { - "description": "Organization ID", - "key": "organizationId", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" - } - }, - "status": "Conflict" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "workspace" - ], - "query": [ + "key": "workspaceId" + }, { - "description": "Organization ID", - "key": "organizationId", - "value": "" + "key": "templateName" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" + ] } }, - "status": "Too Many Requests" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"organizationId\": \"\",\n \"name\": \"\",\n \"isActive\": \"\",\n \"workspaces\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"wxccSubscriptionIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enabledFeatureIds\": [\n \"\",\n \"\"\n ],\n \"settings\": {\n \"general\": {\n \"dataRetentionDays\": \"\"\n },\n \"webex\": {\n \"env\": \"\"\n }\n }\n }\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", "code": 200, "cookie": [], "header": [ @@ -140347,29 +151021,15 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Success", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140378,54 +151038,35 @@ "admin", "v1", "api", - "workspace" + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-name", + ":templateName" ], - "query": [ + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "variable": [ { - "description": "Organization ID", - "key": "organizationId", - "value": "" + "key": "workspaceId" + }, + { + "key": "templateName" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" + ] } }, "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Internal error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"description\": \"\",\n \"name\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140434,16 +151075,21 @@ "admin", "v1", "api", - "workspace" + "profile-view-template", + "workspace-id", + ":workspaceId", + "template-name", + ":templateName" ], - "query": [ + "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "variable": [ { - "description": "Organization ID", - "key": "organizationId", - "value": "" + "key": "workspaceId" + }, + { + "key": "templateName" } - ], - "raw": "{{baseUrl}}/admin/v1/api/workspace?organizationId=" + ] } }, "status": "Internal Server Error" @@ -140451,9 +151097,9 @@ ] }, { - "name": "Get All Template Details.", + "name": "Search for an Identity via aliases", "request": { - "description": "Get Template details by Organization Id and workspaceId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Get one or more Person Details searched by aliases in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes. Multiple aliases should be separated by a comma.", "header": [ { "key": "Accept", @@ -140469,14 +151115,16 @@ "admin", "v1", "api", - "profile-view-template", + "person", "workspace-id", - ":workspaceId" + ":workspaceId", + "aliases", + ":aliases" ], "query": [ { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", + "description": "Sort By Field", + "key": "sortBy", "value": "" }, { @@ -140484,11 +151132,6 @@ "key": "sort", "value": "" }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, { "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", "key": "page", @@ -140500,36 +151143,31 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Aliases to search for. Multiple aliases should be separated by a comma. \n\n In case the alias(es) contain(s) non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "aliases", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Success", + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ @@ -140539,14 +151177,16 @@ "admin", "v1", "api", - "profile-view-template", + "person", "workspace-id", - ":workspaceId" + ":workspaceId", + "aliases", + ":aliases" ], "query": [ { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", + "description": "Sort By Field", + "key": "sortBy", "value": "" }, { @@ -140554,11 +151194,6 @@ "key": "sort", "value": "" }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, { "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", "key": "page", @@ -140570,23 +151205,26 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", "variable": [ { "key": "workspaceId" + }, + { + "key": "aliases" } ] } }, - "status": "OK" + "status": "Not Found" }, { "_postman_previewlanguage": "text", "body": null, - "code": 404, + "code": 500, "cookie": [], "header": [], - "name": "Not found", + "name": "Internal error", "originalRequest": { "header": [], "method": "GET", @@ -140598,14 +151236,16 @@ "admin", "v1", "api", - "profile-view-template", + "person", "workspace-id", - ":workspaceId" + ":workspaceId", + "aliases", + ":aliases" ], "query": [ { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", + "description": "Sort By Field", + "key": "sortBy", "value": "" }, { @@ -140613,11 +151253,6 @@ "key": "sort", "value": "" }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, { "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", "key": "page", @@ -140629,25 +151264,38 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", "variable": [ { "key": "workspaceId" + }, + { + "key": "aliases" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ @@ -140657,14 +151305,16 @@ "admin", "v1", "api", - "profile-view-template", + "person", "workspace-id", - ":workspaceId" + ":workspaceId", + "aliases", + ":aliases" ], "query": [ { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", + "description": "Sort By Field", + "key": "sortBy", "value": "" }, { @@ -140672,11 +151322,6 @@ "key": "sort", "value": "" }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, { "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", "key": "page", @@ -140688,43 +151333,32 @@ "value": "" } ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId?filter=&sort=&sortBy=&page=&pageSize=", + "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", "variable": [ { "key": "workspaceId" + }, + { + "key": "aliases" } ] } }, - "status": "Internal Server Error" + "status": "OK" } ] }, { - "name": "Create Template", + "name": "Get all Journey Actions for a template", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" - }, - "description": "Creates a Profile View Template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Get all Journey Actions for a template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140733,25 +151367,106 @@ "admin", "v1", "api", - "profile-view-template", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" } ] } }, "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + } + ] + } + }, + "status": "Not Found" + }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", - "code": 201, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -140759,29 +151474,15 @@ "value": "application/json" } ], - "name": "Created", + "name": "Success", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -140790,20 +151491,82 @@ "admin", "v1", "api", - "profile-view-template", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" } ] } }, - "status": "Created" + "status": "OK" + } + ] + }, + { + "name": "Create a new Journey Action.", + "request": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, + "description": "Create a new Journey Action in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", @@ -140825,7 +151588,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -140846,14 +151609,19 @@ "admin", "v1", "api", - "profile-view-template", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" } ] } @@ -140863,7 +151631,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "code": 500, "cookie": [], "header": [ { @@ -140871,7 +151639,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Internal server error", "originalRequest": { "body": { "mode": "raw", @@ -140881,7 +151649,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -140902,24 +151670,29 @@ "admin", "v1", "api", - "profile-view-template", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -140927,7 +151700,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Accepted", "originalRequest": { "body": { "mode": "raw", @@ -140937,7 +151710,7 @@ "language": "json" } }, - "raw": "{\n \"attributes\": [\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"aggregationMode\": \"\",\n \"displayName\": \"\",\n \"event\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"metaData\": \"\",\n \"metaDataType\": \"\",\n \"verbose\": \"\",\n \"version\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"name\": \"\"\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -140958,26 +151731,31 @@ "admin", "v1", "api", - "profile-view-template", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "Created" } ] }, { - "name": "Get all or a specific Person Details", + "name": "Get specific Journey Action By Name", "request": { - "description": "Get Person Details in JDS. If personId is provided by query parameter, this returns the Person whose personId matches the parameter.\nIf not, this will return ALL the Persons within the organization and workspace. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Get specific Journey Action By Name in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -140993,56 +151771,122 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-name", + ":actionName" ], - "query": [ - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "variable": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "(Required) Template ID", + "key": "templateId", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "(Required) Action Name", + "key": "actionName", "value": "" } ] } }, "response": [ + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal error", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-name", + ":actionName" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionName" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", + "originalRequest": { + "header": [], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-name", + ":actionName" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionName" + } + ] + } + }, + "status": "Not Found" + }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", "code": 200, "cookie": [], "header": [ @@ -141068,52 +151912,80 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-name", + ":actionName" ], - "query": [ - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "variable": [ { - "description": "Sort direction", - "key": "sort", - "value": "" + "key": "workspaceId" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" + "key": "templateId" }, { - "description": "Number of items to be displayed on a page", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" + "key": "actionName" } ] } }, "status": "OK" - }, + } + ] + }, + { + "name": "Get specific Journey Action By ActionId", + "request": { + "description": "Get specific Journey Action By ActionId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "(Required) Action ID", + "key": "actionId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "text", "body": null, @@ -141132,51 +152004,81 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "query": [ - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ { - "description": "Sort direction", - "key": "sort", - "value": "" + "key": "workspaceId" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" + "key": "templateId" }, { - "description": "Number of items to be displayed on a page", - "key": "pageSize", - "value": "" + "key": "actionId" } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Success", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" } ] } }, - "status": "Not Found" + "status": "OK" }, { "_postman_previewlanguage": "text", @@ -141196,46 +152098,24 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "query": [ - { - "description": "Person ID", - "key": "personId", - "value": "" - }, - { - "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ { - "description": "Sort direction", - "key": "sort", - "value": "" + "key": "workspaceId" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" + "key": "templateId" }, { - "description": "Number of items to be displayed on a page", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId?personId=&filter=&sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" + "key": "actionId" } ] } @@ -141245,7 +152125,7 @@ ] }, { - "name": "Create a Person", + "name": "Update existing Journey Action.", "request": { "body": { "mode": "raw", @@ -141255,9 +152135,9 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, - "description": "Creates a Person in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Update existing Journey Action in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", "header": [ { "key": "Content-Type", @@ -141268,7 +152148,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -141277,16 +152157,30 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "(Required) Action ID", + "key": "actionId", + "value": "" } ] } @@ -141294,8 +152188,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", + "code": 201, "cookie": [], "header": [ { @@ -141303,7 +152197,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Accepted", "originalRequest": { "body": { "mode": "raw", @@ -141313,7 +152207,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -141325,7 +152219,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -141334,24 +152228,34 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" } ] } }, - "status": "Not Found" + "status": "Created" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 201, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], "header": [ { @@ -141359,7 +152263,7 @@ "value": "application/json" } ], - "name": "Created", + "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", @@ -141369,7 +152273,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -141381,7 +152285,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -141390,19 +152294,29 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" } ] } }, - "status": "Created" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", @@ -141425,7 +152339,7 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" }, "header": [ { @@ -141437,7 +152351,7 @@ "value": "application/json" } ], - "method": "POST", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" @@ -141446,24 +152360,84 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" } ] } }, "status": "Internal Server Error" - }, + } + ] + }, + { + "name": "Delete Journey Action configuration By ActionId.", + "request": { + "description": "Delete Journey Action configuration By ActionId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" + }, + { + "description": "(Required) Template ID", + "key": "templateId", + "value": "" + }, + { + "description": "(Required) Action ID", + "key": "actionId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "body": "{\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -141471,29 +152445,15 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Success", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" @@ -141502,47 +152462,127 @@ "admin", "v1", "api", - "person", + "journey-actions", "workspace-id", - ":workspaceId" + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "variable": [ { "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" } ] } }, - "status": "Bad Request" + "status": "OK" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal error", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 404, + "cookie": [], + "header": [], + "name": "Not found", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "admin", + "v1", + "api", + "journey-actions", + "workspace-id", + ":workspaceId", + "template-id", + ":templateId", + "action-id", + ":actionId" + ], + "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "templateId" + }, + { + "key": "actionId" + } + ] + } + }, + "status": "Not Found" } ] }, { - "name": "Merges Identities to a Primary Identity.", + "name": "Historic Progressive Profile View using Template Name.", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" - }, - "description": "Merges one/more Identities to a **Primary** Individual in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -141551,14 +152591,15 @@ "admin", "v1", "api", - "person", - "merge", + "progressive-profile-view", "workspace-id", ":workspaceId", - "primary-person-id", - ":primaryPersonId" + "person-id", + ":personId", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", + "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "variable": [ { "description": "(Required) Workspace ID", @@ -141566,8 +152607,13 @@ "value": "" }, { - "description": "(Required) Primary Person ID", - "key": "primaryPersonId", + "description": "(Required) Person ID", + "key": "personId", + "value": "" + }, + { + "description": "(Required) Template Name", + "key": "templateName", "value": "" } ] @@ -141576,8 +152622,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 202, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], "header": [ { @@ -141585,29 +152631,15 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Bad Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -141616,51 +152648,50 @@ "admin", "v1", "api", - "person", - "merge", + "progressive-profile-view", "workspace-id", ":workspaceId", - "primary-person-id", - ":primaryPersonId" + "person-id", + ":personId", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", + "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "primaryPersonId" + "key": "personId" + }, + { + "key": "templateName" } ] } }, - "status": "Accepted" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -141669,20 +152700,24 @@ "admin", "v1", "api", - "person", - "merge", + "progressive-profile-view", "workspace-id", ":workspaceId", - "primary-person-id", - ":primaryPersonId" + "person-id", + ":personId", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", + "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "primaryPersonId" + "key": "personId" + }, + { + "key": "templateName" } ] } @@ -141690,30 +152725,25 @@ "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -141722,51 +152752,50 @@ "admin", "v1", "api", - "person", - "merge", + "progressive-profile-view", "workspace-id", ":workspaceId", - "primary-person-id", - ":primaryPersonId" + "person-id", + ":personId", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", + "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "primaryPersonId" + "key": "personId" + }, + { + "key": "templateName" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Bad Request", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"personIdsToMerge\": [\n \"\"\n ]\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" @@ -141775,30 +152804,34 @@ "admin", "v1", "api", - "person", - "merge", + "progressive-profile-view", "workspace-id", ":workspaceId", - "primary-person-id", - ":primaryPersonId" + "person-id", + ":personId", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", + "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "primaryPersonId" + "key": "personId" + }, + { + "key": "templateName" } ] } }, - "status": "Bad Request" + "status": "Internal Server Error" } ] }, { - "name": "Creates or merges aliases to an Individual in JDS.", + "name": "Remove one/more Identities from a person", "request": { "body": { "mode": "raw", @@ -141808,50 +152841,122 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "[\n \"\",\n \"\"\n]" }, - "description": "Merges one/more aliases in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "This Patch Api can be used to remove identities(email, phone, customerId) from a person. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope.", "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", "person", - "merge-identities", + "remove-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" + }, + { + "description": "(Required) Person ID", + "key": "personId", + "value": "" } ] } }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "[\n \"\",\n \"\"\n]" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "person", + "remove-identities", + "workspace-id", + ":workspaceId", + "person-id", + ":personId" + ], + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "personId" + } + ] + } + }, + "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 400, "cookie": [], - "header": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "name": "Bad Request", "originalRequest": { "body": { @@ -141862,32 +152967,40 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "[\n \"\",\n \"\"\n]" }, "header": [ { "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", "person", - "merge-identities", + "remove-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } @@ -141896,8 +153009,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, "cookie": [], "header": [ { @@ -141905,7 +153018,7 @@ "value": "application/json" } ], - "name": "OK", + "name": "Resource not found", "originalRequest": { "body": { "mode": "raw", @@ -141915,49 +153028,58 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "[\n \"\",\n \"\"\n]" }, "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", "person", - "merge-identities", + "remove-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "OK" + "status": "Not Found" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { "body": { "mode": "raw", @@ -141967,32 +153089,40 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "[\n \"\",\n \"\"\n]" }, "header": [ { "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", "person", - "merge-identities", + "remove-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } @@ -142000,12 +153130,17 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 401, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "UnAuthorized", "originalRequest": { "body": { "mode": "raw", @@ -142015,44 +153150,52 @@ "language": "json" } }, - "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ]\n}" + "raw": "[\n \"\",\n \"\"\n]" }, "header": [ { "key": "Content-Type", + "value": "application/json-patch+json" + }, + { + "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "PATCH", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", "person", - "merge-identities", + "remove-identities", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId" ], - "raw": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", + "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "variable": [ { "key": "workspaceId" + }, + { + "key": "personId" } ] } }, - "status": "Not Found" + "status": "Unauthorized" } ] }, { - "name": "Get all Journey Actions", + "name": "Historic Progressive Profile View.", "request": { - "description": "Get all Journey Actions in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -142065,40 +153208,31 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", - ":workspaceId" + ":workspaceId", + "person-id", + ":personId", + "template-id", + ":templateId" ], - "query": [ + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", + "variable": [ { - "description": "Sort By Field", - "key": "sortBy", + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "Sort direction", - "key": "sort", + "description": "(Required) Person ID", + "key": "personId", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "(Required) Template ID", + "key": "templateId", "value": "" } ] @@ -142107,7 +153241,7 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -142116,7 +153250,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Ok", "originalRequest": { "header": [ { @@ -142130,227 +153264,77 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", - ":workspaceId" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } + ":workspaceId", + "person-id", + ":personId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "variable": [ { "key": "workspaceId" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" + "key": "personId" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" + "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId?sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" - } - ] - } - }, - "status": "Not Found" - } - ] - }, - { - "name": "Get A specific Template searched by template name", - "request": { - "description": "Get Template details by template Name in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "profile-view-template", - "workspace-id", - ":workspaceId", - "template-name", - ":templateName" - ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, + "header": [ { - "description": "(Required) Template Name", - "key": "templateName", - "value": "" + "key": "Content-Type", + "value": "application/json" } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, - "cookie": [], - "header": [], - "name": "Not found", + ], + "name": "Not Found", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "profile-view-template", + "progressive-profile-view", "workspace-id", ":workspaceId", - "template-name", - ":templateName" + "person-id", + ":personId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "variable": [ { "key": "workspaceId" }, { - "key": "templateName" + "key": "personId" + }, + { + "key": "templateId" } ] } @@ -142359,8 +153343,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"workspaceId\": \"\",\n \"organizationId\": \"\",\n \"attributes\": [\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n }\n ]\n }\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], "header": [ { @@ -142368,7 +153352,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Internal server error", "originalRequest": { "header": [ { @@ -142382,71 +153366,89 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "profile-view-template", + "progressive-profile-view", "workspace-id", ":workspaceId", - "template-name", - ":templateName" + "person-id", + ":personId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "variable": [ { "key": "workspaceId" }, { - "key": "templateName" + "key": "personId" + }, + { + "key": "templateId" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Bad Request", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "profile-view-template", + "progressive-profile-view", "workspace-id", ":workspaceId", - "template-name", - ":templateName" + "person-id", + ":personId", + "template-id", + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "variable": [ { "key": "workspaceId" }, { - "key": "templateName" + "key": "personId" + }, + { + "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" } ] }, { - "name": "Search for an Identity via aliases", + "name": "Historic Progressive Profile View By Identity and Template Name.", "request": { - "description": "Get one or more Person Details searched by aliases in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes. Multiple aliases should be separated by a comma.", + "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -142459,38 +153461,17 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "person", + "progressive-profile-view", "workspace-id", ":workspaceId", - "aliases", - ":aliases" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "description": "(Required) Workspace ID", @@ -142498,8 +153479,13 @@ "value": "" }, { - "description": "(Required) Aliases to search for. Multiple aliases should be separated by a comma. \n\n In case the alias(es) contain(s) non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "aliases", + "description": "(Required) Identity", + "key": "identity", + "value": "" + }, + { + "description": "(Required) Template Name", + "key": "templateName", "value": "" } ] @@ -142507,127 +153493,60 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Not Found", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "person", + "progressive-profile-view", "workspace-id", ":workspaceId", - "aliases", - ":aliases" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "aliases" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "person", - "workspace-id", - ":workspaceId", - "aliases", - ":aliases" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" + "key": "identity" }, { - "key": "aliases" + "key": "templateName" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], "header": [ { @@ -142635,7 +153554,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Bad Request", "originalRequest": { "header": [ { @@ -142649,170 +153568,86 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "person", + "progressive-profile-view", "workspace-id", ":workspaceId", - "aliases", - ":aliases" - ], - "query": [ - { - "description": "Sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "Sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases?sortBy=&sort=&page=&pageSize=", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "aliases" - } - ] - } - }, - "status": "OK" - } - ] - }, - { - "name": "Get all Journey Actions for a template", - "request": { - "description": "Get all Journey Actions for a template in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" + "key": "identity" }, { - "key": "templateId" + "key": "templateName" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", - "template-id", - ":templateId" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" + }, + { + "key": "templateName" } ] } }, - "status": "Not Found" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": [\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n },\n {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ @@ -142821,7 +153656,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Ok", "originalRequest": { "header": [ { @@ -142835,22 +153670,26 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", - "template-id", - ":templateId" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" + }, + { + "key": "templateName" } ] } @@ -142860,51 +153699,43 @@ ] }, { - "name": "Create a new Journey Action.", + "name": "Historic Progressive Profile View By Identity and Template Id", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, - "description": "Create a new Journey Action in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" }, + { + "description": "(Required) identity", + "key": "identity", + "value": "" + }, { "description": "(Required) Template ID", "key": "templateId", @@ -142916,8 +153747,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", + "code": 200, "cookie": [], "header": [ { @@ -142925,60 +153756,50 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Ok", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, + { + "key": "identity" + }, { "key": "templateId" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -142986,60 +153807,50 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Not Found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, + { + "key": "identity" + }, { "key": "templateId" } ] } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", - "code": 201, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 400, "cookie": [], "header": [ { @@ -143047,62 +153858,103 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Bad Request", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" - }, + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "workspace-id", + ":workspaceId", + "identity", + ":identity", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "identity" + }, + { + "key": "templateId" + } + ] + } + }, + "status": "Bad Request" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", + "originalRequest": { + "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, + { + "key": "identity" + }, { "key": "templateId" } ] } }, - "status": "Created" + "status": "Internal Server Error" } ] }, { - "name": "Get specific Journey Action By Name", + "name": "Stream Progressive profile Views By Template Name", "request": { - "description": "Get specific Journey Action By Name in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -143115,18 +153967,18 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "description": "(Required) Workspace ID", @@ -143134,13 +153986,13 @@ "value": "" }, { - "description": "(Required) Template ID", - "key": "templateId", + "description": "(Required) Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", "value": "" }, { - "description": "(Required) Action Name", - "key": "actionName", + "description": "(Required) Template Name", + "key": "templateName", "value": "" } ] @@ -143148,41 +154000,51 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" }, { - "key": "actionName" + "key": "templateName" } ] } @@ -143190,41 +154052,103 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "stream", + "workspace-id", + ":workspaceId", + "identity", + ":identity", + "template-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "identity" + }, + { + "key": "templateName" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 404, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" }, { - "key": "actionName" + "key": "templateName" } ] } @@ -143233,7 +154157,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", + "body": "{\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -143242,7 +154166,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Ok", "originalRequest": { "header": [ { @@ -143256,39 +154180,91 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-name", - ":actionName" + "identity", + ":identity", + "template-name", + ":templateName" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" }, { - "key": "actionName" + "key": "templateName" } ] } }, "status": "OK" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "stream", + "workspace-id", + ":workspaceId", + "identity", + ":identity", + "template-name", + ":templateName" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "identity" + }, + { + "key": "templateName" + } + ] + } + }, + "status": "Too Many Requests" } ] }, { - "name": "Get specific Journey Action By ActionId", + "name": "Stream Progressive profile Views", "request": { - "description": "Get specific Journey Action By ActionId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_read or cjp:config_write scopes", + "description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", @@ -143301,18 +154277,18 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", - ":templateId", - "action-id", - ":actionId" + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "description": "(Required) Workspace ID", @@ -143320,13 +154296,13 @@ "value": "" }, { - "description": "(Required) Template ID", - "key": "templateId", + "description": "(Required) Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", "value": "" }, { - "description": "(Required) Action ID", - "key": "actionId", + "description": "(Required) Template ID", + "key": "templateId", "value": "" } ] @@ -143334,41 +154310,155 @@ }, "response": [ { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, "cookie": [], - "header": [], - "name": "Not found", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", - ":templateId", - "action-id", - ":actionId" + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, + { + "key": "identity" + }, { "key": "templateId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 429, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Too many requests", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "stream", + "workspace-id", + ":workspaceId", + "identity", + ":identity", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "variable": [ + { + "key": "workspaceId" }, { - "key": "actionId" + "key": "identity" + }, + { + "key": "templateId" + } + ] + } + }, + "status": "Too Many Requests" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 404, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource not found", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "progressive-profile-view", + "stream", + "workspace-id", + ":workspaceId", + "identity", + ":identity", + "template-id", + ":templateId" + ], + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "variable": [ + { + "key": "workspaceId" + }, + { + "key": "identity" + }, + { + "key": "templateId" } ] } @@ -143377,7 +154467,7 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", + "body": "{\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -143386,7 +154476,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Ok", "originalRequest": { "header": [ { @@ -143400,27 +154490,27 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", - ":templateId", - "action-id", - ":actionId" + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" }, { - "key": "actionId" + "key": "templateId" } ] } @@ -143428,41 +154518,51 @@ "status": "OK" }, { - "_postman_previewlanguage": "text", - "body": null, + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "code": 500, "cookie": [], - "header": [], - "name": "Internal error", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Internal server error", "originalRequest": { - "header": [], + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "progressive-profile-view", + "stream", "workspace-id", ":workspaceId", + "identity", + ":identity", "template-id", - ":templateId", - "action-id", - ":actionId" + ":templateId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" + "key": "identity" }, { - "key": "actionId" + "key": "templateId" } ] } @@ -143472,61 +154572,69 @@ ] }, { - "name": "Update existing Journey Action.", + "name": "Historic Journey Events", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, - "description": "Update existing Journey Action in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Getting Historic Customer Journey Events from Pinot. These events are append-only, immutable data ledger that can be queried to retrieve snapshot of latest events that moment in time or historically to play-back events as they occurred to understand or analyze Journeys using ML/AI models. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes ", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ + "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", "value": "" }, { - "description": "(Required) Template ID", - "key": "templateId", + "description": "sort By Field", + "key": "sortBy", "value": "" }, { - "description": "(Required) Action ID", - "key": "actionId", + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" } ] @@ -143535,8 +154643,8 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n }\n}", - "code": 201, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], "header": [ { @@ -143544,65 +154652,77 @@ "value": "application/json" } ], - "name": "Accepted", + "name": "Internal server error", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", + "value": "" }, { - "key": "templateId" + "description": "sort By Field", + "key": "sortBy", + "value": "" }, { - "key": "actionId" + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" } ] } }, - "status": "Created" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "code": 404, "cookie": [], "header": [ { @@ -143610,65 +154730,233 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Resource not found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" - }, + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "events", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", + "value": "" + }, + { + "description": "sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" + } + ] + } + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 409, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Resource already exists", + "originalRequest": { + "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "query": [ + { + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", + "value": "" + }, + { + "description": "sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", "variable": [ { "key": "workspaceId" + } + ] + } + }, + "status": "Conflict" + }, + { + "_postman_previewlanguage": "json", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"resultCount\": \"\",\n \"identity\": \"\"\n },\n \"data\": [\n {\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n },\n {\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n }\n ]\n}", + "code": 200, + "cookie": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "name": "Ok", + "originalRequest": { + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "api", + "events", + "workspace-id", + ":workspaceId" + ], + "query": [ + { + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", + "value": "" + }, + { + "description": "sort By Field", + "key": "sortBy", + "value": "" + }, + { + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" }, { - "key": "templateId" + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" }, { - "key": "actionId" + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" } ] } }, - "status": "Bad Request" + "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -143676,105 +154964,122 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Too many requests", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"name\": \"\",\n \"rules\": {\n \"logic\": \"\",\n \"args\": [\n \"\",\n \"\"\n ]\n },\n \"cooldownPeriodInMinutes\": \"\",\n \"actionTriggers\": [\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n },\n {\n \"type\": \"\",\n \"agentId\": \"\",\n \"title\": \"\",\n \"welcomeMessage\": \"\"\n }\n ],\n \"isActive\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + ":workspaceId" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", + "value": "" }, { - "key": "templateId" + "description": "sort By Field", + "key": "sortBy", + "value": "" }, { - "key": "actionId" + "description": "sort direction", + "key": "sort", + "value": "" + }, + { + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" + }, + { + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + }, + { + "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "key": "page", + "value": "" + }, + { + "description": "Number of items to be displayed on a page.", + "key": "pageSize", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "variable": [ + { + "key": "workspaceId" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Delete Journey Action configuration By ActionId.", + "name": "Stream Events By Identity", "request": { - "description": "Delete Journey Action configuration By ActionId in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope", + "description": "Real-time streaming enables API consumers to listen for events as it arrives as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Optionally accepts filter and data parameters slice/dice further. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", "header": [ { "key": "Accept", "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ + "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", "value": "" }, { - "description": "(Required) Template ID", - "key": "templateId", + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "variable": [ + { + "description": "(Required) Workspace ID", + "key": "workspaceId", "value": "" }, { - "description": "(Required) Action ID", - "key": "actionId", + "description": "(Required) Person Identity. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", + "key": "identity", "value": "" } ] @@ -143783,7 +155088,7 @@ "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"createdAt\": \"\",\n \"createdBy\": \"\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"isActive\": \"\",\n \"templateId\": \"\",\n \"cooldownPeriodInMinutes\": \"\",\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n },\n \"actionTriggers\": [\n {\n \"type\": \"\"\n },\n {\n \"type\": \"\"\n }\n ]\n}", + "body": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}", "code": 200, "cookie": [], "header": [ @@ -143792,7 +155097,7 @@ "value": "application/json" } ], - "name": "Success", + "name": "Ok", "originalRequest": { "header": [ { @@ -143800,177 +155105,50 @@ "value": "application/json" } ], - "method": "DELETE", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "journey-actions", + "events", + "stream", "workspace-id", ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "templateId" + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "actionId" + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal error", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", "variable": [ { "key": "workspaceId" }, { - "key": "templateId" - }, - { - "key": "actionId" + "key": "identity" } ] } }, - "status": "Internal Server Error" + "status": "OK" }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 404, - "cookie": [], - "header": [], - "name": "Not found", - "originalRequest": { - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "journey-actions", - "workspace-id", - ":workspaceId", - "template-id", - ":templateId", - "action-id", - ":actionId" - ], - "raw": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "templateId" - }, - { - "key": "actionId" - } - ] - } - }, - "status": "Not Found" - } - ] - }, - { - "name": "Historic Progressive Profile View using Template Name.", - "request": { - "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "admin", - "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" - ], - "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Person ID", - "key": "personId", - "value": "" - }, - { - "description": "(Required) Template Name", - "key": "templateName", - "value": "" - } - ] - } - }, - "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -143978,7 +155156,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Resource already exists", "originalRequest": { "header": [ { @@ -143992,32 +155170,39 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "progressive-profile-view", + "events", + "stream", "workspace-id", ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "variable": [ + { + "key": "workspaceId" }, { - "key": "templateName" + "key": "identity" } ] } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "json", @@ -144030,7 +155215,7 @@ "value": "application/json" } ], - "name": "Not Found", + "name": "Resource not found", "originalRequest": { "header": [ { @@ -144044,27 +155229,34 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "progressive-profile-view", + "events", + "stream", "workspace-id", ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "variable": [ + { + "key": "workspaceId" }, { - "key": "templateName" + "key": "identity" } ] } @@ -144073,8 +155265,8 @@ }, { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", - "code": 200, + "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "code": 500, "cookie": [], "header": [ { @@ -144082,7 +155274,7 @@ "value": "application/json" } ], - "name": "Ok", + "name": "Internal server error", "originalRequest": { "header": [ { @@ -144096,37 +155288,44 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "progressive-profile-view", + "events", + "stream", "workspace-id", ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "variable": [ + { + "key": "workspaceId" }, { - "key": "templateName" + "key": "identity" } ] } }, - "status": "OK" + "status": "Internal Server Error" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 429, "cookie": [], "header": [ { @@ -144134,7 +155333,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Too many requests", "originalRequest": { "header": [ { @@ -144148,37 +155347,44 @@ "{{baseUrl}}" ], "path": [ - "admin", "v1", "api", - "progressive-profile-view", + "events", + "stream", "workspace-id", ":workspaceId", - "person-id", - ":personId", - "template-name", - ":templateName" + "identity", + ":identity" ], - "raw": "{{baseUrl}}/admin/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", - "variable": [ + "query": [ { - "key": "workspaceId" + "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "filter", + "value": "" }, { - "key": "personId" + "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", + "key": "data", + "value": "" + } + ], + "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "variable": [ + { + "key": "workspaceId" }, { - "key": "templateName" + "key": "identity" } ] } }, - "status": "Internal Server Error" + "status": "Too Many Requests" } ] }, { - "name": "Remove one/more Identities from a person", + "name": "Journey Event Posting", "request": { "body": { "mode": "raw", @@ -144188,53 +155394,44 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, - "description": "This Patch Api can be used to remove identities(email, phone, customerId) from a person. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjp:config_write scope.", + "description": "Journey Event Posting Api.API accepts events that describe what occurred, when, and by whom on every interaction across touch points and applications. Data Ingestion is based on Cloud Events specification for describing event data in a common way. API accepts data in the form of POST with support for Header based authorization. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ + "query": [ { "description": "(Required) Workspace ID", "key": "workspaceId", "value": "" - }, - { - "description": "(Required) Person ID", - "key": "personId", - "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\"\n },\n \"data\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"temporaryId\": [\n \"\",\n \"\"\n ],\n \"customerId\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n}", + "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\"\n },\n \"data\": {\n \"message\": \"\"\n }\n}", "code": 200, "cookie": [], "header": [ @@ -144253,42 +155450,37 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, "status": "OK" @@ -144296,7 +155488,7 @@ { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "code": 409, "cookie": [], "header": [ { @@ -144304,7 +155496,7 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "Resource already exists", "originalRequest": { "body": { "mode": "raw", @@ -144314,50 +155506,45 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, - "status": "Bad Request" + "status": "Conflict" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "code": 429, "cookie": [], "header": [ { @@ -144365,7 +155552,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "Too many requests", "originalRequest": { "body": { "mode": "raw", @@ -144375,50 +155562,45 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, - "status": "Not Found" + "status": "Too Many Requests" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "code": 404, "cookie": [], "header": [ { @@ -144426,7 +155608,7 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "Resource not found", "originalRequest": { "body": { "mode": "raw", @@ -144436,50 +155618,45 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, - "status": "Internal Server Error" + "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 401, + "code": 500, "cookie": [], "header": [ { @@ -144487,7 +155664,7 @@ "value": "application/json" } ], - "name": "UnAuthorized", + "name": "Internal server error", "originalRequest": { "body": { "mode": "raw", @@ -144497,252 +155674,207 @@ "language": "json" } }, - "raw": "[\n \"\",\n \"\"\n]" + "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" }, "header": [ { "key": "Content-Type", - "value": "application/json-patch+json" + "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], - "method": "PATCH", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ + "publish", "v1", "api", - "person", - "remove-identities", - "workspace-id", - ":workspaceId", - "person-id", - ":personId" + "event" ], - "raw": "{{baseUrl}}/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", - "variable": [ - { - "key": "workspaceId" - }, + "query": [ { - "key": "personId" + "description": "(Required) Workspace ID", + "key": "workspaceId", + "value": "" } - ] + ], + "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" } }, - "status": "Unauthorized" + "status": "Internal Server Error" } ] - }, + } + ], + "name": "Journey" + }, + { + "item": [ { - "name": "Historic Progressive Profile View.", + "name": "Start Campaign Request", "request": { - "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications. This type of API typically allows businesses to set up the parameters for a campaign, such as the list of phone numbers to call, the message or script to deliver, and the time of day or day of the week to call. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Person ID", - "key": "personId", - "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", - "value": "" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Invalid or absent Authorization header", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "personId" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, - "status": "OK" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Not Found", + "header": [], + "name": "Incorrect fields in request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "personId" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, - "status": "Not Found" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "personId" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, - "status": "Internal Server Error" + "status": "Forbidden" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "body": "{\n \"data\": \"\",\n \"meta\": {\n \"orgId\": \"\"\n }\n}", + "code": 202, "cookie": [], "header": [ { @@ -144750,342 +155882,163 @@ "value": "application/json" } ], - "name": "Bad Request", + "name": "The campaign was started for processing.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "person-id", - ":personId", - "template-id", - ":templateId" - ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "personId" - }, - { - "key": "templateId" + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ] - } - }, - "status": "Bad Request" - } - ] - }, - { - "name": "Historic Progressive Profile View By Identity and Template Name.", - "request": { - "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" - ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Identity", - "key": "identity", - "value": "" + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" }, - { - "description": "(Required) Template Name", - "key": "templateName", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Not Found", - "originalRequest": { "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" - ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", - "originalRequest": { - "header": [ + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" - ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" - } - ] + "{{baseUrl}}" + ], + "path": [ + "v1", + "dialer", + "campaign" + ], + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, - "status": "Bad Request" + "status": "Accepted" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Internal Server Error", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Service Unavailable", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" - } - ] + "raw": "{{baseUrl}}/v1/dialer/campaign" } }, - "status": "OK" + "status": "Service Unavailable" } ] }, { - "name": "Historic Progressive Profile View By Identity and Template Id", + "name": "Update Campaign Request", "request": { - "description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, + "description": "By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications. This can help to improve efficiency and reduce errors, as well as allow for greater flexibility and control over outbound campaigns. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) identity", - "key": "identity", - "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId", "value": "" } ] @@ -145093,162 +156046,239 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\"\n },\n \"data\": [\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n },\n {\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" } ] } }, - "status": "OK" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Not Found", + "header": [], + "name": "Incorrect fields in request", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" } ] } }, - "status": "Not Found" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 400, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Bad Request", + "header": [], + "name": "Service Unavailable", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 500, + "cookie": [], + "header": [], + "name": "Internal Server Error", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dialer", + "campaign", + ":campaignId" + ], + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "variable": [ { - "key": "identity" - }, + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" + } + ] + } + }, + "status": "Internal Server Error" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Invalid or absent Authorization header", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "PUT", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dialer", + "campaign", + ":campaignId" + ], + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "variable": [ { - "key": "templateId" + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" } ] } }, - "status": "Bad Request" + "status": "Unauthorized" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "body": "{\n \"data\": \"\",\n \"meta\": {\n \"orgId\": \"\"\n }\n}", + "code": 202, "cookie": [], "header": [ { @@ -145256,90 +156286,73 @@ "value": "application/json" } ], - "name": "Internal server error", + "name": "The campaign was updated successfully", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" + "description": "The unique request id of the campaign that needs to be updated", + "key": "campaignId" } ] } }, - "status": "Internal Server Error" + "status": "Accepted" } ] }, { - "name": "Stream Progressive profile Views By Template Name", + "name": "Stop Campaign Request", "request": { - "description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "description": "The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "(Required) Template Name", - "key": "templateName", + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId", "value": "" } ] @@ -145347,51 +156360,30 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Internal Server Error", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" } ] } @@ -145399,267 +156391,209 @@ "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Invalid OAuth 2.0 Bearer Token", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" } ] } }, - "status": "Conflict" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Invalid or absent Authorization header", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" } ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 204, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "The campaign was stopped.", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateName" + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" } ] } }, - "status": "OK" + "status": "No Content" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 503, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Service Unavailable", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", + "header": [], + "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-name", - ":templateName" + "dialer", + "campaign", + ":campaignId" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "variable": [ { - "key": "workspaceId" - }, - { - "key": "identity" - }, + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" + } + ] + } + }, + "status": "Service Unavailable" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Incorrect fields in request", + "originalRequest": { + "header": [], + "method": "DELETE", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dialer", + "campaign", + ":campaignId" + ], + "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "variable": [ { - "key": "templateName" + "description": "The unique request id of the campaign that needs to be stopped", + "key": "campaignId" } ] } }, - "status": "Too Many Requests" + "status": "Bad Request" } ] - }, + } + ], + "name": "Campaign Manager" + }, + { + "item": [ { - "name": "Stream Progressive profile Views", + "name": "List Captures", "request": { - "description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, + "description": "Retrieve a list of Captures given a set of task IDs", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "(Required) Template ID", - "key": "templateId", - "value": "" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "body": "{\n \"data\": [\n {\n \"recording\": [\n {\n \"attributes\": {\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"stopTime\": \"\",\n \"participants\": [\n \"\",\n \"\"\n ],\n \"channel1\": \"\",\n \"channel2\": \"\",\n \"callType\": \"\"\n },\n \"id\": \"\",\n \"segment\": \"\"\n },\n {\n \"attributes\": {\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"stopTime\": \"\",\n \"participants\": [\n \"\",\n \"\"\n ],\n \"channel1\": \"\",\n \"channel2\": \"\",\n \"callType\": \"\"\n },\n \"id\": \"\",\n \"segment\": \"\"\n }\n ],\n \"transcription\": [\n {\n \"Source\": \"\",\n \"Provider\": \"\",\n \"id\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"languageCode\": \"\",\n \"createTime\": \"\"\n },\n {\n \"Source\": \"\",\n \"Provider\": \"\",\n \"id\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"languageCode\": \"\",\n \"createTime\": \"\"\n }\n ],\n \"taskId\": \"\"\n },\n {\n \"recording\": [\n {\n \"attributes\": {\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"stopTime\": \"\",\n \"participants\": [\n \"\",\n \"\"\n ],\n \"channel1\": \"\",\n \"channel2\": \"\",\n \"callType\": \"\"\n },\n \"id\": \"\",\n \"segment\": \"\"\n },\n {\n \"attributes\": {\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"stopTime\": \"\",\n \"participants\": [\n \"\",\n \"\"\n ],\n \"channel1\": \"\",\n \"channel2\": \"\",\n \"callType\": \"\"\n },\n \"id\": \"\",\n \"segment\": \"\"\n }\n ],\n \"transcription\": [\n {\n \"Source\": \"\",\n \"Provider\": \"\",\n \"id\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"languageCode\": \"\",\n \"createTime\": \"\"\n },\n {\n \"Source\": \"\",\n \"Provider\": \"\",\n \"id\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"startTime\": \"\",\n \"languageCode\": \"\",\n \"createTime\": \"\"\n }\n ],\n \"taskId\": \"\"\n }\n ],\n \"meta\": {\n \"orgId\": \"\",\n \"urlExpiration\": \"\"\n }\n}", + "code": 200, "cookie": [], "header": [ { @@ -145667,261 +156601,288 @@ "value": "application/json" } ], - "name": "Resource already exists", + "name": "Returns Recording and Transcription details. If a provided taskId is not found for the specified organization, the API will return a 200 OK response with empty recording and transcription fields for that task.\nThis behavior is intentional to allow partial", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, - "status": "Conflict" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 429, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Too many requests have been sent in a given amount of time and the request has been rate limited", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, "status": "Too Many Requests" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" + "header": [], + "name": "Not Found", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "captures", + "query" + ], + "raw": "{{baseUrl}}/v1/captures/query" } - ], - "name": "Resource not found", + }, + "status": "Not Found" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 401, + "cookie": [], + "header": [], + "name": "Unauthorized, token is invalid", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" + ], + "raw": "{{baseUrl}}/v1/captures/query" + } + }, + "status": "Unauthorized" + }, + { + "_postman_previewlanguage": "text", + "body": null, + "code": 400, + "cookie": [], + "header": [], + "name": "Error: urlExpiration should be greater than 0.", + "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, - "status": "Not Found" + "status": "Bad Request" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"organizationId\": \"\",\n \"personId\": \"\",\n \"templateId\": \"\",\n \"workspaceId\": \"\",\n \"searchFilter\": \"\",\n \"attributes\": [\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n },\n {\n \"queryTemplate\": {\n \"displayName\": \"\",\n \"version\": \"\",\n \"event\": \"\",\n \"metaDataType\": \"\",\n \"metaData\": \"\",\n \"limit\": \"\",\n \"lookBackDurationType\": \"\",\n \"lookBackPeriod\": \"\",\n \"aggregationMode\": \"\",\n \"verbose\": \"\",\n \"widgetAttributes\": {\n \"type\": \"\"\n },\n \"rules\": {\n \"type\": \"\",\n \"childrenRules\": {\n \"type\": \"\"\n }\n }\n },\n \"result\": \"\",\n \"error\": \"\",\n \"journeyEvents\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"systemMetdata\": {\n \"journeyActionTriggerHistories\": [\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n },\n {\n \"actionId\": \"\",\n \"doNotDisturbPeriod\": \"\",\n \"triggeredAt\": \"\"\n }\n ]\n },\n \"timestamp\": \"\"\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Forbidden From Accessing Resources", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, - "status": "OK" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", + "_postman_previewlanguage": "text", + "body": null, "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "An Unexpected Error Occurred", "originalRequest": { + "body": { + "mode": "raw", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + }, + "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\",\n \"includeVARecordings\": \"\"\n }\n}" + }, "header": [ { - "key": "Accept", + "key": "Content-Type", "value": "application/json" } ], - "method": "GET", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", - "api", - "progressive-profile-view", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity", - "template-id", - ":templateId" + "captures", + "query" ], - "raw": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", - "variable": [ - { - "key": "workspaceId" - }, - { - "key": "identity" - }, - { - "key": "templateId" - } - ] + "raw": "{{baseUrl}}/v1/captures/query" } }, "status": "Internal Server Error" } ] - }, + } + ], + "name": "Captures" + }, + { + "item": [ { - "name": "Historic Journey Events", + "name": "List Flows or Subflows", "request": { - "description": "Getting Historic Customer Journey Events from Pinot. These events are append-only, immutable data ledger that can be queried to retrieve snapshot of latest events that moment in time or historically to play-back events as they occurred to understand or analyze Journeys using ML/AI models. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes ", + "description": "Returns a list of flows in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", "header": [ { "key": "Accept", @@ -145934,54 +156895,59 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "sort By Field", - "key": "sortBy", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "sort direction", - "key": "sort", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", "value": "" } ] @@ -145989,87 +156955,77 @@ }, "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 400, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Bad request", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "sort By Field", - "key": "sortBy", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "sort direction", - "key": "sort", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Internal Server Error" + "status": "Bad Request" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "body": "[\n {\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"key_0\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n },\n {\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"key_0\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n }\n]", + "code": 200, "cookie": [], "header": [ { @@ -146077,7 +157033,7 @@ "value": "application/json" } ], - "name": "Resource not found", + "name": "OK", "originalRequest": { "header": [ { @@ -146091,807 +157047,427 @@ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "sort By Field", - "key": "sortBy", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "sort direction", - "key": "sort", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Not Found" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Not Found", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "sort By Field", - "key": "sortBy", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "sort direction", - "key": "sort", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Conflict" + "status": "Not Found" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\",\n \"resultCount\": \"\",\n \"identity\": \"\"\n },\n \"data\": [\n {\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n },\n {\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n }\n ]\n}", - "code": 200, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", + "header": [], + "name": "Forbidden", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "sort By Field", - "key": "sortBy", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "sort direction", - "key": "sort", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", - "key": "page", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "OK" + "status": "Forbidden" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "_postman_previewlanguage": "text", + "body": null, + "code": 500, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", + "header": [], + "name": "Internal Server Error", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "workspace-id", - ":workspaceId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - }, - { - "description": "sort By Field", - "key": "sortBy", - "value": "" - }, - { - "description": "sort direction", - "key": "sort", - "value": "" - }, - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" }, { - "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.", + "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", - "value": "" - }, - { - "description": "Number of items to be displayed on a page.", - "key": "pageSize", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId?identity=&sortBy=&sort=&filter=&data=&page=&pageSize=", - "variable": [ - { - "key": "workspaceId" - } - ] - } - }, - "status": "Too Many Requests" - } - ] - }, - { - "name": "Stream Events By Identity", - "request": { - "description": "Real-time streaming enables API consumers to listen for events as it arrives as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Optionally accepts filter and data parameters slice/dice further. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" - }, - { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", - "value": "" - } - ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", - "variable": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - }, - { - "description": "(Required) Person Identity. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.", - "key": "identity", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}", - "code": 200, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" - } - ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", - "variable": [ - { - "key": "workspaceId" }, { - "key": "identity" - } - ] - } - }, - "status": "OK" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" }, { - "key": "identity" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Conflict" + "status": "Internal Server Error" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Unauthorized", "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows" ], "query": [ { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "FLOW" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", + "key": "ids", "value": "" - } - ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", - "variable": [ - { - "key": "workspaceId" }, { - "key": "identity" - } - ] - } - }, - "status": "Not Found" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of the displayed page. The page number starts from 0.", + "key": "page", + "value": "0" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", + "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", + "key": "partialNameSearch", "value": "" - } - ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", - "variable": [ - { - "key": "workspaceId" }, { - "key": "identity" - } - ] - } - }, - "status": "Internal Server Error" - }, - { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, - "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Too many requests", - "originalRequest": { - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "api", - "events", - "stream", - "workspace-id", - ":workspaceId", - "identity", - ":identity" - ], - "query": [ - { - "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "filter", - "value": "" + "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", + "key": "size", + "value": "10" }, { - "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/docs/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).", - "key": "data", - "value": "" + "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", + "key": "includePagination", + "value": "false" } ], - "raw": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity?filter=&data=", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "variable": [ { - "key": "workspaceId" + "description": "Organization ID.", + "key": "orgId" }, { - "key": "identity" + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Too Many Requests" + "status": "Unauthorized" } ] }, { - "name": "Journey Event Posting", + "name": "Export a Flow or Subflow", "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" - }, - "description": "Journey Event Posting Api.API accepts events that describe what occurred, when, and by whom on every interaction across touch points and applications. Data Ingestion is based on Cloud Events specification for describing event data in a common way. API accepts data in the form of POST with support for Header based authorization. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes", + "description": "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "publish", - "v1", - "api", - "event" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" } ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" - } - }, - "response": [ - { - "_postman_previewlanguage": "json", - "body": "{\n \"meta\": {\n \"organizationId\": \"\",\n \"workspaceId\": \"\"\n },\n \"data\": {\n \"message\": \"\"\n }\n}", - "code": 200, - "cookie": [], - "header": [ + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", + "variable": [ { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Ok", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" + "description": "Organization ID.", + "key": "orgId", + "value": "" }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "publish", - "v1", - "api", - "event" - ], - "query": [ - { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" - } - ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" } - }, - "status": "OK" - }, + ] + } + }, + "response": [ { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 409, + "_postman_previewlanguage": "text", + "body": null, + "code": 404, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource already exists", + "header": [], + "name": "Not Found", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "publish", - "v1", - "api", - "event" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" } ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" + } + ] } }, - "status": "Conflict" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 429, + "body": "{\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"key_0\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"key_0\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -146899,172 +157475,141 @@ "value": "application/json" } ], - "name": "Too many requests", + "name": "OK", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" - }, "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "method": "POST", + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "publish", - "v1", - "api", - "event" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" } ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" + } + ] } }, - "status": "Too Many Requests" + "status": "OK" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 404, + "_postman_previewlanguage": "text", + "body": null, + "code": 401, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Resource not found", + "header": [], + "name": "Unauthorized", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "publish", - "v1", - "api", - "event" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" } ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" + } + ] } }, - "status": "Not Found" + "status": "Unauthorized" }, { - "_postman_previewlanguage": "json", - "body": "{\n \"trackingId\": \"\",\n \"timestamp\": \"\",\n \"status\": \"415 UNSUPPORTED_MEDIA_TYPE\",\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", - "code": 500, + "_postman_previewlanguage": "text", + "body": null, + "code": 403, "cookie": [], - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "name": "Internal server error", + "header": [], + "name": "Forbidden", "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"data\": {\n \"agentId\": \"\",\n \"destination\": \"\",\n \"profileType\": \"\",\n \"currentState\": \"\",\n \"idleCodeId\": \"\",\n \"createdTime\": \"\"\n },\n \"datacontenttype\": \"\",\n \"id\": \"\",\n \"identity\": \"\",\n \"identitytype\": \"\",\n \"source\": \"\",\n \"specversion\": \"\",\n \"type\": \"\",\n \"time\": \"\",\n \"previousidentity\": \"\"\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "POST", + "header": [], + "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "publish", - "v1", - "api", - "event" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:export" ], "query": [ { - "description": "(Required) Workspace ID", - "key": "workspaceId", - "value": "" + "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", + "key": "version", + "value": "latest" } ], - "raw": "{{baseUrl}}/publish/v1/api/event?workspaceId=" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" + } + ] } }, - "status": "Internal Server Error" + "status": "Forbidden" } ] - } - ], - "name": "Journey" - }, - { - "item": [ + }, { - "name": "Start Campaign Request", + "name": "Publish a Flow or Subflow", "request": { "body": { "mode": "raw", @@ -147074,10 +157619,15 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, - "description": "A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications. This type of API typically allows businesses to set up the parameters for a campaign, such as the list of phone numbers to call, the message or script to deliver, and the time of day or day of the week to call. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization", + "description": "Returns the published flow in response.\n\nThe Publish API validates the basic structure of the flows. We recommend manually verifying the published flows before proceeding with live traffic.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -147093,21 +157643,36 @@ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" + } + ] } }, "response": [ { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 404, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Not Found", "originalRequest": { "body": { "mode": "raw", @@ -147117,48 +157682,14 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign" - } - }, - "status": "Unauthorized" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 400, - "cookie": [], - "header": [], - "name": "Incorrect fields in request", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ { "key": "Content-Type", "value": "application/json" @@ -147170,58 +157701,32 @@ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign" - } - }, - "status": "Bad Request" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, - "cookie": [], - "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } - }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign" + ] } }, - "status": "Forbidden" + "status": "Not Found" }, { "_postman_previewlanguage": "json", - "body": "{\n \"data\": \"\",\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 202, + "body": "{\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"draftVersion\": {\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_1\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_2\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"key_0\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"key_1\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"key_2\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_1\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"key_3\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_2\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"key_0\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"key_2\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n },\n \"flowType\": \"\",\n \"flowVersions\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"latestVersion\": {\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_1\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_2\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"key_0\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_1\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"key_2\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"key_1\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"key_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"key_1\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"key_0\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"key_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"key_0\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n },\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"orgId\": \"\",\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"projectId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"key_0\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"key_1\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"validating\": \"\",\n \"version\": \"\"\n}", + "code": 200, "cookie": [], "header": [ { @@ -147229,7 +157734,7 @@ "value": "application/json" } ], - "name": "The campaign was started for processing.", + "name": "OK", "originalRequest": { "body": { "mode": "raw", @@ -147239,9 +157744,14 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" @@ -147257,61 +157767,35 @@ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign" - } - }, - "status": "Accepted" - }, - { - "_postman_previewlanguage": "text", - "body": null, - "code": 500, - "cookie": [], - "header": [], - "name": "Internal Server Error", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } - }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign" + ] } }, - "status": "Internal Server Error" + "status": "OK" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 201, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Created", "originalRequest": { "body": { "mode": "raw", @@ -147321,122 +157805,46 @@ "language": "json" } }, - "raw": "{\n \"id\": \"\",\n \"vendorVersion\": \"\",\n \"campaignType\": \"\",\n \"dialingRate\": \"\",\n \"entryPointId\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"recordCount\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"abandonRatePercentage\": \"\",\n \"predictiveCorrectionPace\": \"\",\n \"predictiveGain\": \"\",\n \"reservationPercentage\": \"\",\n \"callProgressAnalysisParams\": {\n \"cpaEnabled\": \"\",\n \"amdEnabled\": \"\",\n \"minSilencePeriod\": \"\",\n \"analysisPeriod\": \"\",\n \"minimumValidSpeech\": \"\",\n \"maxTimeAnalysis\": \"\",\n \"maxTermToneAnalysis\": \"\",\n \"terminatingToneDetect\": \"\"\n },\n \"ivrPorts\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign" - } - }, - "status": "Service Unavailable" - } - ] - }, - { - "name": "Update Campaign Request", - "request": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" - }, - "description": "By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications. This can help to improve efficiency and reduce errors, as well as allow for greater flexibility and control over outbound campaigns. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization.", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "PUT", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", - "variable": [ - { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId", - "value": "" - } - ] - } - }, - "response": [ - { - "_postman_previewlanguage": "text", - "body": null, - "code": 403, - "cookie": [], - "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", - "originalRequest": { - "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" - }, - "header": [ { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Forbidden" + "status": "Created" }, { "_postman_previewlanguage": "text", @@ -147444,7 +157852,7 @@ "code": 400, "cookie": [], "header": [], - "name": "Incorrect fields in request", + "name": "Bad request", "originalRequest": { "body": { "mode": "raw", @@ -147454,30 +157862,41 @@ "language": "json" } }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } @@ -147487,10 +157906,10 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 403, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", @@ -147500,35 +157919,46 @@ "language": "json" } }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Service Unavailable" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", @@ -147546,30 +157976,41 @@ "language": "json" } }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } @@ -147582,7 +158023,7 @@ "code": 401, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", @@ -147592,40 +158033,115 @@ "language": "json" } }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}" }, "header": [ + { + "description": "ID for tracking.", + "key": "TrackingId", + "value": "" + }, { "key": "Content-Type", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows", + "{{flowId}}:publish" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, "status": "Unauthorized" + } + ] + }, + { + "name": "Import a Flow or Subflow", + "request": { + "body": { + "mode": "params" }, + "description": "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]", + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "url": { + "host": [ + "{{baseUrl}}" + ], + "path": [ + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" + ], + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", + "variable": [ + { + "description": "Organization ID.", + "key": "orgId", + "value": "" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId", + "value": "" + } + ] + } + }, + "response": [ { "_postman_previewlanguage": "json", - "body": "{\n \"data\": \"\",\n \"meta\": {\n \"orgId\": \"\"\n }\n}", - "code": 202, + "body": "{\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"key_0\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n}", + "code": 201, "cookie": [], "header": [ { @@ -147633,79 +158149,65 @@ "value": "application/json" } ], - "name": "The campaign was updated successfully", + "name": "CREATED: Flow or Subflow is created.", "originalRequest": { "body": { - "mode": "raw", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - }, - "raw": "{\n \"dialingRate\": \"\",\n \"dialingListFetchURL\": \"\",\n \"outdialANI\": \"\",\n \"campaignName\": \"\",\n \"authToken\": \"\",\n \"noAnswerRingLimit\": \"\",\n \"maxDialingRate\": \"\",\n \"reservationPercentage\": \"\",\n \"previewOfferTimeout\": \"\",\n \"previewOfferTimeoutAutoAction\": \"\",\n \"previewActionsDisabled\": [\n \"\",\n \"\"\n ]\n}" + "mode": "params" }, "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, { "key": "Content-Type", - "value": "application/json" + "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], - "method": "PUT", + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be updated", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Accepted" - } - ] - }, - { - "name": "Stop Campaign Request", - "request": { - "description": "The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires one of the following scopes 'cjp:user' or 'cjp.config_write' for authorization.", - "header": [], - "method": "DELETE", - "url": { - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" - ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", - "variable": [ - { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId", - "value": "" - } - ] - } - }, - "response": [ + "status": "Created" + }, { "_postman_previewlanguage": "text", "body": null, @@ -147714,23 +158216,53 @@ "header": [], "name": "Internal Server Error", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } @@ -147740,167 +158272,318 @@ { "_postman_previewlanguage": "text", "body": null, - "code": 403, + "code": 400, "cookie": [], "header": [], - "name": "Invalid OAuth 2.0 Bearer Token", + "name": "BAD REQUEST: Possible causes - Import file size exceeded the limit. File parse error. Flow name is empty. Invalid flow type. Invalid activity.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Forbidden" + "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": null, - "code": 401, + "code": 403, "cookie": [], "header": [], - "name": "Invalid or absent Authorization header", + "name": "Forbidden", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Unauthorized" + "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": null, - "code": 204, + "code": 401, "cookie": [], "header": [], - "name": "The campaign was stopped.", + "name": "Unauthorized", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "No Content" + "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": null, - "code": 503, + "code": 409, "cookie": [], "header": [], - "name": "Service Unavailable", + "name": "CONFLICT: A flow/subflow with the same name already exists.", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Service Unavailable" + "status": "Conflict" }, { "_postman_previewlanguage": "text", "body": null, - "code": 400, + "code": 404, "cookie": [], "header": [], - "name": "Incorrect fields in request", + "name": "Not Found", "originalRequest": { - "header": [], - "method": "DELETE", + "body": { + "mode": "params" + }, + "header": [ + { + "description": "Content length value in number of bytes.", + "key": "Content-Length", + "value": "" + }, + { + "key": "Content-Type", + "value": "multipart/form-data" + } + ], + "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ - "v1", - "dialer", - "campaign", - ":campaignId" + "flow-store", + ":orgId", + "project", + ":projectId", + "flows:import" ], - "raw": "{{baseUrl}}/v1/dialer/campaign/:campaignId", + "query": [ + { + "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", + "key": "overwrite", + "value": "" + }, + { + "description": "Either of 'FLOW' or 'SUBFLOW'.", + "key": "flowType", + "value": "" + } + ], + "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "variable": [ { - "description": "The unique request id of the campaign that needs to be stopped", - "key": "campaignId" + "description": "Organization ID.", + "key": "orgId" + }, + { + "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.", + "key": "projectId" } ] } }, - "status": "Bad Request" + "status": "Not Found" } ] } ], - "name": "Campaign Manager" + "name": "Flow" }, { + "description": "APIs for scheduling and managing callbacks for customers.", "item": [ { - "name": "List Captures", + "name": "Schedule a Callback", "request": { "body": { "mode": "raw", @@ -147910,9 +158593,9 @@ "language": "json" } }, - "raw": "{\n \"query\": {\n \"taskIds\": [\n \"\",\n \"\"\n ],\n \"orgId\": \"\",\n \"urlExpiration\": \"\",\n \"includeSegments\": \"\"\n }\n}" + "raw": "{\n \"customerName\": \"\",\n \"callbackNumber\": \"\",\n \"timezone\": \"\",\n \"scheduleDate\": \"\",\n \"startTime\": \"